API referencePay In endpointsSubscriptions

Update subscription

Updates a subscription's details.

Path parameters

subIdintegerRequired
The subscription ID.

Headers

requestTokenstringRequired

Request

This endpoint expects an object.
paymentDetailsobjectOptional

Object describing details of the payment. To skip the payment, set the totalAmount to 0. Payments will be paused until the amount is updated to a non-zero value. When totalAmount is set to 0, the serviceFee must also be set to 0.

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 is not calculated automatically. If you want to skip a payment instead, set the totalAmount to 0 in the paymentDetails object.

Response

Success
isSuccessboolean or null

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

responseDatastring or null

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.

responseTextstring or null

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

Errors