payoutSubscription

Update a payout subscription

Updates a payout subscription's details. See Manage payout subscriptions for more information.

put/PayoutSubscription/{id}

Request

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

Path parameters

idinteger required

The payout subscription ID.

Request body

setPauseboolean

Flag indicating if the payout subscription is paused. When a payout subscription is paused, no payouts are processed until it's unpaused, and the next payment date isn't calculated automatically.

Response

Success

isSuccessboolean

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

responseTextstring required

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

responseDatastring

If isSuccess = true, this contains the payout subscription ID. When the subscription is paused, it also includes a description (for example, "42 paused").

If isSuccess = false, this contains the reason for the failure.

customerIdinteger

The Payabli-generated unique ID for the customer.

Changes

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