Skip to main content
objectBillingSubscription

Fields

status
BillingSubscriptionStatus!
planKey
BillingPlanKey!
planCode
String

Internal plan code string from the billing provider.

planName
String!
interval
BillingInterval
cancelsAt
DateTime

The date the subscription is scheduled to cancel at the end of the current period. Null if not set to cancel.

trialEndsAt
DateTime

The date the free trial ends. Null if not on a trial.

entitlements
[BillingFeatureEntitlement!]!

List of feature entitlements for the current plan, indicating which features are available and any usage limits.

endedAt
DateTime

The date the subscription was terminated. Null if still active.

checkoutSession
HyperlineCheckoutSession

An in-progress Hyperline checkout session, if one exists for this workspace.

creditBalances
[BillingCreditBalance!]!

Current credit balances across all credit products (monthly allowance and top-up). Empty array if no credit products are attached.