Add-ons
Purchase Add-on
Initiate a checkout session for a tenant to purchase an add-on.
POST
Creates a Stripe checkout session for the tenant to purchase an add-on. Credits are granted automatically after payment confirmation via webhook (
event_type: addon_purchase).
The call is idempotent — passing the same idempotencyKey twice returns the original result without creating a duplicate checkout.
Path Parameters
The external tenant ID from your application
Request Body
The add-on ID to purchase (from the available add-ons list)
3-letter ISO currency code. Must match the tenant’s subscription currency.
Unique key for this purchase event. Duplicate calls with the same key return the original result.
URL to redirect to after payment. Defaults to the org’s configured success URL.
URL to redirect to if the user cancels. Defaults to the org’s configured cancel URL.
Optional context stored on the purchase record.
Authentication
Requires a secret key (Authorization: Bearer sk_live_...) or service key (x-service-key).