Skip to main content
GET
Get Account Status

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

Subscription state of the account an API key belongs to.

organization_id
string
required

ULID identifier for the account (organization) the API key belongs to.

organization_name
string
required

Display name of the account.

plan
string
required

Machine-readable name of the account's subscription plan, for example enterprise. Empty when the account has no plan on file.

plan_display_name
string
required

Human-readable name of the account's subscription plan, for example Enterprise. Empty when the account has no plan on file.

status
enum<string>
required

Subscription state of the account. Values active, trialing, past_due, unpaid, paused, incomplete, canceled, and incomplete_expired mirror Stripe's subscription statuses. subscription_not_found means Scrunch holds no Stripe subscription record for the account (normal for manually invoiced accounts) and is not a sign the account lapsed. unknown means Scrunch cannot vouch for the current state; keep your current behavior rather than treating it as a lapse.

Available options:
active,
trialing,
past_due,
unpaid,
paused,
incomplete,
canceled,
incomplete_expired,
subscription_not_found,
unknown
current_period_start
string<date-time> | null
required

Start of the current billing period, in UTC. null when no subscription is on file.

current_period_end
string<date-time> | null
required

End of the current billing period, in UTC. While status is trialing, this is also the date the trial ends. null when no subscription is on file.