API reference
Billing API
Plans and payment: the price list, hosted checkout, the provider's billing portal, the current subscription, payment history, receipts as JSON or PDF, and the billing profile.
Endpoints
9 operations, each with its parameters, schemas and an example request on its own page.
- post/api/billing/checkoutStart a checkout — Starts a hosted checkout and returns where to send the browser.
- get/api/billing/paymentsPayment history — Every charge on this workspace, newest first.
- get/api/billing/payments/{payment_id}/receiptGet a receipt — One receipt as JSON, for rendering in the dashboard.
- get/api/billing/payments/{payment_id}/receipt.pdfDownload a receipt as PDF — The receipt as a PDF - the file somebody forwards to their accountant.
- get/api/billing/plansList plans — The price list, and which row the caller is on.
- post/api/billing/portalOpen the billing portal — A link into the provider's billing portal.
- get/api/billing/profileGet the billing profile — The billing address and tax registration, for the settings form.
- put/api/billing/profileUpdate the billing profile — Updates the billing profile.
- get/api/billing/subscriptionGet the subscription — The plan, the balance and what it buys - the billing page header.
Authentication
Every call here needs Authorization: Bearer with a key from the dashboard — Authentication covers keys and scopes.
Objects returned
The models these endpoints send back, with every field. Open one to read it.
Message2 fields
messagestringrequiredokbooleanDefault: true
Something here wrong or missing? Tell us — the documentation and the API are maintained by the same person, so a correction is a fix rather than a ticket.