Subscriptions

Make a billing plan, send the customer a link to subscribe, and Inkress charges their card each cycle.

1Make a plan

Create a plan with POST /api/v1/billing_plans: name, flat_rate (what each cycle costs), currency_code, billing_cycle (1 day, 2 week, 3 month, 4 year) and duration (the Inkress dashboard sends the same value as billing_cycle). trial_period is a free trial in days.

2Subscribe a customer

Call POST /api/v1/billing_subscriptions/link with the plan's uid as plan_id, your reference_id, a title and the customer. You get an order back; send the customer to its payment URL. When they pay, the subscription starts and their card is kept for renewals.

Renewals reuse the 3-D Secure check from the first payment, so customers aren't asked again each cycle.

3Charge now

Charge a subscription outside its cycle with POST /api/v1/billing_subscriptions/:uid/charge and a reference_id and total. The regular schedule doesn't move. Some subscriptions are charged in the background: you get 202 queued and poll Charge status with the same reference.

When a renewal fails

Each failed attempt sends subscriptions.payment_attempt_failed and Inkress tries again. When it gives up you get subscriptions.payment_failed and the subscription's status becomes 5. Make a card update link with POST /api/v1/billing_subscriptions/:uid/card-update-link and send it to the customer; they add a new card without contacting you, and the subscription is billed again.