Billing status
get_billing_statusThis organisation's billing state. Works in EVERY state — it is never blocked, so you can always ask it why other tools are returning payment_required. States: 'trialing' (free first month), 'grace' (free grace month — everything works; days_until_next_transition counts down to the access pause; if it is small, tell your operator to subscribe at payment_url — $20/org/month), 'walled' (access paused until someone subscribes at payment_url; the books are safe and still ingesting), 'active' (subscribed), 'past_due' (a payment failed; Stripe is retrying and emailing the operator), 'comped' (complimentary — payment_url is null, nothing to pay; if comped_until is set this is a beta-partner comp and that DATE is when the free period ends — days_until_next_transition stays null for comped, so read comped_until; a past comped_until means the beta period is wrapping up and the org enters its 30-day grace period within a day). payment_url is a page for HUMANS: relay it to your operator, never try to complete payment yourself.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Optional. Defaults to the organisation the authenticated API key is bound to, so you normally omit it and never need to ask the user for their organisation UUID. If provided, it must match the key’s org or the request is rejected. | 0e91146d-511c-469f-bdee-5c867b26ae0d |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| price | Yes | ||
| state | Yes | ||
| payment_url | Yes | ||
| comped_until | Yes | ||
| deletion_scheduled | Yes | ||
| days_until_next_transition | Yes |