Skip to navigation
APIPay In endpointsSubscriptions

Update subscription

View as MarkdownOpen in Claude
Updates a subscription's details.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
requestTokenstring

Long-lived API token sent in the requestToken header. See API token authentication.

Path parameters

subIdintegerRequired
The subscription ID.

Request

This endpoint expects an object.
invoiceDataobject or nullOptional

Object describing an invoice linked to the subscription. Replaces the subscription’s existing invoice data entirely. Send null to remove it, or leave it out to keep the current invoice data. See Update a subscription for details.

paymentDetailsobjectOptional

Object describing details of the payment. For Regular subscriptions, skip a payment by setting totalAmount to 0; payments pause until you update it to a non-zero value, and serviceFee must also be 0 when totalAmount is 0. For BalanceDriven subscriptions, any totalAmount you send is accepted but ignored at run time. Each run charges the payor’s live balance, and a zero balance is skipped.

scheduleDetailsobjectOptional
Object describing the schedule for subscription
setPausebooleanOptional

Flag indicating if subscription is paused. When a subscription is paused, no payments are processed until the subscription is unpaused, and the next payment date isn’t calculated automatically. If you want to skip a payment instead, set the totalAmount to 0 in the paymentDetails object.

Response

Success
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

responseDatastringOptional

If isSuccess = true, this contains the identifier of the subscription, and sometimes extra information, depending on what was updated.

If isSuccess = false, this contains the reason for the failure.

customerIdlongOptional

The Payabli-generated unique ID for the customer.