PUT
/
Subscription
/
{subId}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/Subscription/{subId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "setPause": false,
  "paymentDetails": {
    "totalAmount": 100,
    "serviceFee": 0,
    "currency": "USD",
    "checkNumber": "107",
    "checkImage": {},
    "categories": [
      {
        "label": "Deposit",
        "description": "Deposit for materials",
        "amount": 1000,
        "qty": 1
      }
    ],
    "splitFunding": [
      {
        "recipientEntryPoint": "41035afaa7",
        "accountId": "187-782",
        "description": "Split for annual dues",
        "amount": 456.23
      }
    ]
  },
  "scheduleDetails": {
    "planId": 123,
    "startDate": "<string>",
    "endDate": "<string>",
    "frequency": "monthly"
  }
}'
{
  "isSuccess": true,
  "responseText": "Success",
  "responseData": "396 paused"
}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

subId
integer
required

The subscription ID.

Example:

231

Body

setPause
boolean

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.

Example:

false

paymentDetails
object

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.

scheduleDetails
object

Object describing the schedule for subscription

Response

200
application/json
Success

Success response

isSuccess
boolean

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

Example:

true

responseText
string | null

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

Example:

"Success"

responseData
string | 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.

Example:

"396"

Was this page helpful?