Skip to main content

CapabilitySubscription

Normalized subscription summary derived from the current session's snapshots subscription, with status adjusted for trial credit-card failures and temporary plans.

type CapabilitySubscription {
active: Boolean!
state: SubscriptionState!
endDate: Int
plan: SubscriptionPlanDetails
billingPeriod: SubscriptionPlanPeriod
}

Fields​

CapabilitySubscription.active ● Boolean! non-null scalar​

Whether the subscription is active, non-temporary, and free of the trial card-failure state.

CapabilitySubscription.state ● SubscriptionState! non-null enum​

Normalized lifecycle state used for subscription alerts and access decisions.

CapabilitySubscription.endDate ● Int scalar​

Subscription end or renewal time in Unix seconds; -1 for free plans, null if no date is available.

CapabilitySubscription.plan ● SubscriptionPlanDetails object​

Plan metadata; null for a temporary subscription.

CapabilitySubscription.billingPeriod ● SubscriptionPlanPeriod enum​

The interval the account is committed to going forward (for a trial, the plan it converts to).

Returned By​

subscription query