Organizations

Get billing status

Returns the organization's subscription and seat state. Requires the billing:view permission. For what the org may actually use, prefer GET /organization/{id}/entitlements.

get/organization/{id}/billing

Request

  • Base URL: https://api.elaichi.ai
  • URL: https://api.elaichi.ai/organization/{id}/billing
  • Auth: HTTP bearer

Path parameters

idstring required

Organization id (org_…).

Response

OK

planstring

Stored plan on the row: gold, black, or none once locked.

effective_plan'gold' | 'black' | 'null' nullable

What the org is actually entitled to right now, after trial and Stripe subscription status are taken into account. null means locked: gated features refuse with subscription_required.

trial_ends_atstring date-time nullable
trial_activeboolean

The Gold trial before a subscription starts. A Stripe trialing subscription is not this flag.

stripe_customer_idstring nullable
stripe_subscription_idstring nullable
stripe_subscription_statusstring nullable
stripe_price_idstring nullable
has_customerboolean
billing_configuredboolean

False when billing is not enabled for the service.

seat_countinteger

Billable memberships, with the paid-subscription minimum of one. This is the quantity billed.

Changes

No recorded changes to this operation across all 1 revision of this API.