incomplete state together with its first charge, and returns the checkout link to redirect your customer to. The subscription becomes active once that first charge is paid — see the lifecycle.
Body
Number of
interval units per cycle. A cycle may not exceed one year: at most 366 for day, 52 for week, 12 for month, 1 for year.Your reference for this subscription, 1–50 characters. Unique per merchant: repeating one returns HTTP 409 with the existing subscription instead of creating a second one.
HTTPS URL that receives the signed subscription events. Strongly recommended — it is the only way to learn about renewals without polling.
How long the customer has to pay the first charge, in seconds. Between
1200 and 7200. After that the subscription becomes incomplete_expired.Your identifier for the customer, maximum 255 characters. Lets you filter List Subscriptions by customer.
Total number of payments to collect (installments), first charge included. Omit for an open-ended subscription. When the last payment is collected the subscription is canceled with
cancellation_reason: completed.Card subscriptions are coming soon. Sending
true is refused with card_recurring_not_enabled unless card recurring is enabled on your affiliation.Response Fields
Identifier of the first charge. You can follow it with Verify Payment like any payment.
Errors
Two shapes: a field that fails validation comes back as{"<field>": ["<reason>"]} (no envelope); a refusal by the platform comes back enveloped, with the code in result.error.
