Guides
Payment and checkout
Hosted checkout
Take a card or bank payment on a hosted page and create the subscription.
Customer portal
Let customers see invoices, update payment methods and manage their plan.
Subscriptions
Create your first subscription
Customer → product → subscription → activation.
Subscription lifecycle
Upgrades, downgrades, renewals and cancellations.
Usage-based billing
Usage metering
Define a metric, price it, and send usage events.
Credits and prepaid
Prepaid credits, wallets and real-time consumption.
Events and self-serve
Webhooks
Receive notifications for billing events.
Launch self-serve
Trials, credits, checkout and portal in one flow.
Before you start
Get an API key
- Sign in to the dashboard — or sandbox while you build
- Go to Settings → Connections → Developers → API keys
- Create a key and keep it server-side
Base URLs
Authentication and versioning
Send the key as a Bearer token and pin the API version on every request:Common integration patterns
Pattern 1: Checkout → subscription → invoice
The usual self-serve flow:Pattern 2: API-first subscription
When your application already knows the customer and plan — sales-led deals, or self-serve with a stored payment method:Pattern 3: Usage-based billing
Need help?
API reference
Every endpoint, generated from the OpenAPI spec.
Support
Include the
X-Request-Id of any failed request.