Create Subscription, Scheduled Payment, or Autopay
Creates a subscription or scheduled payment to run at a specified time and frequency.
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Headers
A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.
"6B29FC40-CA47-1067-B31D-00DD010662DA"
Query Parameters
When true
, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.
Body
The entrypoint identifier.
50
"d193cf9a46"
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
50
"mypage-1"
Custom identifier to indicate the transaction or request source.
100
"api"
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
Information about the payment method for the transaction. Required and recommended fields for each payment method type are described in each schema below.
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 customer/payor.
Object describing an Invoice linked to the subscription.
Object describing the schedule for subscription.
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.
If isSuccess
= false, this contains the reason for the failure."
"396"
Payabli-generated unique ID of the customer the subscription belongs to.
"4440"
Was this page helpful?