Skip to main content

Recurring Payments

Overview​

The Recurring Payments service allows you to manage subscription plans via API. Through the Plans API, implementers can create plans, query existing plans, and update or manage them—enabling recurring charges and subscription-based payment flows for your application or website.

Key Features​

Plan creation​

Create subscription plans via the API. The plan creation endpoint returns a subscriptionUrl, which is the front-end URL where the customer completes checkout. Use this URL to redirect users to the payment flow after a plan is created.

Plan query​

Retrieve or list existing plans. Query endpoints let you fetch a single plan by identifier or list plans according to your filters, so you can display plan details or manage them in your back office.

Plan management​

Update and manage plans after creation. You can modify plan details, and when applicable, deactivate or remove plans. These operations are exposed through the same API used for creation and query.

Benefits​

  • Flexibility: Offer your users payment plans that fit their needs (installments, recurring billing).
  • Automation: Manage plans and recurring charges through the API without manual steps.
  • Integration: Use the subscriptionUrl to send users to a ready-to-use checkout experience.

Sequence diagram​

More information​

See the Recurring Payments API for endpoint details, request and response schemas, and authentication.

Checkout with subscriptionUrl​

With the subscription URL returned by the plan creation, we provide the ability to redirect the customer to the payment page and complete the payment flow.