Create subscription
Headers
Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn’t generated in Payabli, you must generate it yourself.
Query parameters
When true
, the request creates a new customer record, regardless of whether customer identifiers match an existing customer. Defaults to false
.
Request
Object describing the customer/payor.
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.
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
The Payabli-generated unique ID for the customer.
Response text for operation: ‘Success’ or ‘Declined’.
Boolean indicating whether the operation was successful. A true
value indicates success. A false
value indicates failure.