Subscriptions

Returns a paginated list of subscriptions. Filter by customerId to list subscriptions for a specific customer, or by email to find subscriptions by customer email address.

Create a new subscription linked to a plan and a customer vault.

planId is required unless you provide a customSchedule. They are mutually exclusive.

customSchedule lets you define a custom plan inline with: amount, dayFrequency, dayOfMonth, monthFrequency, payments.

customerVaultId or customerId (both accepted) — links the subscription to a customer vault. The customer's default payment method (card or ACH) is used.

startDate — optional. If omitted, the subscription starts on the next scheduled date.

autoRenew — automatically renew after the last payment cycle.

notificationMail — send receipt notifications via email/SMS.

attachments — file paths from the /upload-attachments endpoint.

Retrieve a single subscription by ID.

Cancel and delete a subscription.

Update an existing subscription.

Updatable fields: amount, surcharge, autoRenew, notificationMail, customerVaultId, attachments.

To change the customer vault (and thus the payment method), provide a new customerVaultId.

attachments: Upload files first via /upload-attachments, then pass the file path objects here.

Pause an active subscription. No charges will be processed while paused. Use resume to re-activate.

Resume a previously paused subscription. Processing resumes either on the day it was unpaused or based on the configured plan settings. Charges will continue as scheduled once resumed.

Manually trigger a payment for a failed scheduled entry in a subscription. Provide the scheduleId from the subscription's schedule array.

Upload attachment files to associate with a subscription (e.g. contracts, agreements). Use the returned file path objects in the attachments field when creating or updating a subscription.

File limits: Up to 10 files per request, max 25 MB total.

Supported formats: JPG, PNG, PDF.