SCscrunch
account

Get Account Status

Changed on

Get the subscription state of the account this API key belongs to. Use status to tell a trial from a paid or churned account: trialing means the account is in its trial, and current_period_end is the date that trial ends. subscription_not_found means the account has no Stripe subscription on file, which is normal for manually invoiced accounts and is not a sign that the account lapsed. unknown means Scrunch cannot vouch for the account's current state, either because its billing record is no longer being kept up to date or because it is in a state this endpoint does not publish yet; keep your current behavior rather than treating it as a lapse.

get/account

Request

Response

Successful Response

organization_idstring required

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

organization_namestring required

Display name of the account.

planstring required

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

plan_display_namestring required

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

status'active' | 'trialing' | 'past_due' | 'unpaid' | 'paused' | 'incomplete' | 'canceled' | 'incomplete_expired' | 'subscription_not_found' | 'unknown' 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.

current_period_startstring date-time nullable required

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

current_period_endstring date-time nullable 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.

Changes