Skip to main content

Recurring Payments API

The Recurring Payments API allows you to create, query, and manage subscription plans, customers, payment methods, subscriptions, and charges.

Sections​

  • Plans - Create and manage subscription plans
  • Customers - List and get customers, payment methods, subscriptions
  • Payment methods - Get payment method by ID
  • Subscriptions - List, get, update and cancel subscriptions
  • Charges - List charges and get charge details with attempt history
  • Checkout - Subscription flow with the interface provided by subscriptionUrl
  • Webhooks - Event catalog and integration guide (Platform Webhooks / partner channel)

Webhooks​

Recurring Payments emits asynchronous events when subscriptions, charges, or plans change. For tenant-level integrations, register listeners in Platform Webhooks and handle the JSON data payload (includes event_type).

Get started with Webhooks · Platform Webhooks overview

Authentication​

All requests require a JWT token in the Authorization header.

​

JWT obtained in the authentication flow

Security Scheme Type:

apiKey

Header parameter name:

authorization