Skip to main content

Checkout

Overview​

Checkout is the hosted flow the customer completes when subscribing to a plan. You do not embed a payment form: create a plan, then send the customer to subscription_url.

That URL looks like:

https://<checkout-host>/checkout/<plan_id>

<checkout-host> is the Recurring Payments frontend for your tenant. <plan_id> is the plan UUID returned by the API.

Checkout flow​

1. Review your subscription​

The customer sees the merchant, plan name, amount and billing frequency, and — when proration applies — the first charge until the next billing date.

Step 1 - Review your subscription

2. Your data​

The customer enters the data used to create their account. Email identifies the customer in the portal (unique per merchant). Name is required. Phone, document, and other fields may be required depending on your tenant configuration.

Step 2 - Your data

3. Payment​

The customer enters card details (number, expiration, CVV, cardholder name, and document when required). The card is tokenized and registered for recurring charges. Card data does not pass through your backend.

Step 3 - Payment

4. Success​

The subscription is active. The customer sees a confirmation with the next billing date.

  • If the plan has redirect_url, they can return to your site.
  • They can also open the customer portal to manage the subscription.

Integration​

  1. Create a plan with the Plans API. The response includes subscription_url.
  2. Redirect the customer to subscription_url (or share the link).
  3. The customer completes checkout.
  4. Recurring charges run according to the plan. Listen to webhooks for subscription.created and charge events.

Customer portal​

After checkout, the customer can open the portal from the success screen or from emails (for example after a charge).

If the portal session expires, they are redirected to:

https://<checkout-host>/session-request/<merchant_id>

They enter the same email used at checkout and receive a new portal link. <merchant_id> is the merchant UUID returned in plan and customer responses.

More information​