Skip to main content
POST
Start agency client checkout

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Body

application/json

Generate a per-client Stripe Checkout link for an agency subaccount on a tiered client plan. Choose tier (starter, growth, or scale) and interval (monthly or annual). Optional priceId must match the server price for that tier and interval.

subaccountId
string
required

The agency subaccount (client) company id to bill. Must be the token's own company or a subaccount whose parentCompanyId is the token company.

Minimum string length: 1
tier
enum<string>

Client plan tier. Required in practice — if omitted (and priceId does not identify a client tier), the API returns invalid_request ("Choose Starter, Growth, or Scale for this client.").

Available options:
starter,
growth,
scale
interval
enum<string>
default:monthly

Billing interval for the client plan. Defaults to monthly.

Available options:
monthly,
annual
priceId
string

Optional Stripe price id. When supplied, must match the server price for the selected client tier and interval.

Response

Stripe Checkout link for the agency billing manager.

Envelope for POST /agency/billing/subscription-link.

data
object
required