Create Add-On Checkout

Create a checkout for an organization add-on version and billing cycle. Store checkout_id locally and verify the checkout before enabling paid add-on behavior in your integration.

Authorization

BearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

addon_slug*string

Add-on slug, for example release-smartlinks or members-management.

Request Body

application/json

Request payload.

TypeScript Definitions

Use the request body type in TypeScript.

addon_version*string

Version of the add-on being purchased or activated, matching a version available to the organization.

cycle?string

Billing cycle requested for the add-on checkout, such as monthly or yearly when both are offered.

gateway*string

Payment gateway used for this checkout or billing flow.

Value in

"airwallex"
"stripe"
"paypal"

success_url?string

Public URL returned for this resource or action.

Formaturi

cancel_url?string

Public URL returned for this resource or action.

Formaturi

[key: string]?any

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/addons/release-smartlinks/checkout" \  -H "Content-Type: application/json" \  -d '{    "addon_version": "1.3.0",    "cycle": "monthly",    "gateway": "airwallex",    "success_url": "https://northstar-distribution.co.uk/addons/release-smartlinks/success",    "cancel_url": "https://northstar-distribution.co.uk/addons/release-smartlinks/cancel"  }'

{  "success": true,  "message": "Checkout created.",  "data": {    "license_id": "f05e3ae3-4b17-45bd-a22f-e33d715b3486",    "addon_slug": "release-smartlinks",    "addon_version": "1.3.0",    "status": "active",    "flow": "organization_install",    "installed": true,    "activated_at": "2026-07-04T10:15:00+00:00",    "checkout": {      "checkout_id": "39b189c1-8f8e-4df2-8632-176f87f791a1",      "gateway": "airwallex",      "status": "pending",      "redirect_url": "https://checkout.spacemedia-docs.invalid/session/docs-checkout-session",      "embedded_checkout_token": "docs_invalid_embedded_checkout_token",      "amount": 49,      "currency": "GBP",      "expires_at": "2026-07-04T10:30:00+00:00"    }  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

403application/json

404application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`