Subscription

Represents a subscription with its current status and limits. The authenticated user’s subscription. Under external billing, configured entitlements are returned for an existing user even without a stored subscription. Without a stored billing record under Stripe billing, the free plan is returned with no record id. Seat usage, the usage that seat changes and invitations are checked against, is returned on every read.

FieldTypeDescription
idIDBilling record ID. Null when the account has no stored billing record.
typeSubscriptionType!
cycleSubscriptionCycle
statusStringDerived status: active, canceled, expired, or deleted
currentPeriodStartString
currentPeriodEndString
quantityInt
expiresAtString
createdAtStringBilling record creation time. Null when the account has no stored billing record.
canceledAtString
seatUsageSubscriptionSeatUsageSeat usage that seat changes and invitations are checked against. Query.subscription returns it for every user session, including an account without a stored billing record.
projectIdIDProject this subscription is scoped to, when applicable
lineItems[SubscriptionLineItem!]Subscription line items. Credits are one-time top-ups and are not included here.

All GraphQL types · Operations