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

Response

200
application/json

Success

Success response