Subscription

Update a subscription

Updates a subscription's details.

put/Subscription/{subId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Subscription/{subId}
  • Auth: HTTP bearer

Path parameters

subIdinteger required

The subscription ID.

Request body

setPauseboolean

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

isSuccessboolean

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

responseDatastring

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 required

Response text for operation: 'Success' or 'Declined'.

customerIdinteger

The Payabli-generated unique ID for the customer.

Changes

No recorded changes to this operation across all 1 revision of this API.