API reference · Billing
Get the subscription
The plan, the balance and what it buys - the billing page header.
- Authentication
- Bearer token
- Retries
- Safe to repeat
- Body
- None
- Version
- 2026-09-03
Not owner-gated. Every dashboard needs the credit balance to render, and a member seeing "1,240 credits left" is not a disclosure - it is the number that stops them wondering why an answer was refused.
Responses
- 200OKapplication/json
object
5 response headers
- RateLimit-Limit
Requests permitted in the current window.
- RateLimit-Remaining
Requests left in the current window. Back off before it reaches 0.
- RateLimit-Reset
Seconds until the current window resets.
- X-API-Version
The dated version of the API contract that served this response, e.g.
2026-09-03. Pin against it; it changes only when a response shape changes incompatibly.- X-Request-ID
Quote this in a support request to identify the call.
Example request
curl "https://api.integrable.cloud/api/billing/subscription" \
-H "Authorization: Bearer $INTEGRABLE_API_KEY"Set INTEGRABLE_API_KEY first. The same call from the TypeScript or Python SDK takes the same fields.
Errors
Failures use one envelope on every endpoint, described in Retries, versioning and limits. The codes you are most likely to meet here:
unauthenticated· 401 — The request carried no API key, or one the API could not verify.forbidden· 403 — The key is valid, but it is not allowed to do this — either the scope is missing or the resource belongs to another workspace.rate_limited· 429 — Too many requests in the current window. The limit is per workspace, and some endpoints add a per-bot limit on top.
More Billing endpoints
- post/api/billing/checkoutStart a checkout
- get/api/billing/paymentsPayment history
- get/api/billing/payments/{payment_id}/receiptGet a receipt
- get/api/billing/payments/{payment_id}/receipt.pdfDownload a receipt as PDF
- get/api/billing/plansList plans
- post/api/billing/portalOpen the billing portal
- get/api/billing/profileGet the billing profile
- put/api/billing/profileUpdate the billing profile
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.