Start a checkout
Asks Polar for a page where the customer pays for a plan. Poll GET /billing/checkout/ until status is ready, then send them checkout_url. As in the dashboard, only a business on the free plan can start one, and only while nobody else’s checkout for it is open; a business that already pays changes plan in Polar’s billing portal. Those, a managed plan and a plan this deployment doesn’t sell are a 409. With a platform key the checkout is made out to the business’s owner, so a business nobody has claimed yet is a 409.
Authorizations
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. Only platform keys can hold businesses:create and users:create.
Headers
The business a platform key acts on. Required with a platform key. A per-business key may leave it out; if it sends one, it must be the key's own business.
A unique value, up to 255 characters, that makes retries of this request safe for 24 hours.
255Body
Response
Accepted
A Polar checkout for a plan.