Create plans and offers, follow subscriptions and their billing cycles, and cancel them.
Subscriptions charge a buyer on a schedule. Create a plan (amount, currency, interval, and optional trial), then send a buyer an offer for one or more plans. The buyer accepts the offer on the hosted page or through the Payin SDK, and that creates the subscription. Payment Labs then charges the buyer's saved instrument every billing cycle and records each cycle as a subscription payment.
| Subscription status | Meaning |
|---|---|
CREATING | Waiting for the first checkout, which verifies the buyer's instrument. |
TRIAL | In the trial period. nextPaymentDate is the first charge date. |
ACTIVE | Active. nextPaymentDate is the next charge date. |
OVERDUE | Every retry of the last billing cycle failed. |
FAILED | The first checkout failed or expired. The buyer must subscribe again. Final. |
CANCELLED | Cancelled by you or the buyer. It is not charged again. Final. |
| Subscription payment status | Meaning |
|---|---|
PENDING | The billing cycle is being charged. |
COMPLETED | The cycle was paid. |
FAILED | A charge attempt failed. Payment Labs charges each cycle at most three times in total — the first attempt and two retries, at least 24 hours apart. If the last attempt fails, the subscription becomes OVERDUE. |
A plan is ACTIVE or CANCELED. Deleting a plan cancels it: buyers can no longer subscribe to it, and existing subscriptions continue. See Subscriptions.