Update Subscription, Scheduled Payment, or Autopay
Updates a subscription’s details.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
The subscription ID.
231
Body
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.
false
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.
Object describing the schedule for subscription
Response
Success response
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.
true
Response text for operation: 'Success' or 'Declined'.
"Success"
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.
"396"
Was this page helpful?