Skip to main content
POST
Start a tier checkout

Authorizations

Authorization
string
header
required

An API key from Settings > API keys (lsk_...), which acts on its own business, or a platform key from the PLATFORM_API_KEYS setting (lsp_...), which onboards and manages businesses. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:read, knowledge:write, webhooks:manage, billing:manage, phone_numbers:manage, team:manage, businesses:create, users:create, phone_numbers:purchase, partner:read, partner.businesses:write, partner.demos:write, partner.packages:write, partner.branding:write, partner.templates:write, partner.team:write, partner.billing:read, partner.billing:write. Only platform keys can hold businesses:create and users:create, and only a key a partner made in its console can hold the partner scopes, which the Partner endpoints use. Only a partner's owners grant partner.billing:read and partner.billing:write.

Headers

Idempotency-Key
string

A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.

Maximum string length: 255

Body

application/json
tier
enum<string>
required
Available options:
starter,
growth,
scale
interval
enum<string>
required
Available options:
monthly,
annual

Response

Accepted

data
object
required