Javascript Types BillingSubscriptionResource
BillingSubscriptionResource
The BillingSubscriptionResource
type represents a subscription to a plan.
Name activeAt
Type Date
Description The date when the subscription became active.
Name createdAt
Type Date
Description The date when the subscription was created.
Name eligibleForFreeTrial?
Type boolean
Description Whether the payer is eligible for a free trial.
Name id
Type string
Description The unique identifier for the subscription.
Name nextPayment
Type null | { amount: BillingMoneyAmount ; date: Date; }
Description Information about the next payment, including the amount and the date it's due. Returns null if there is no upcoming payment.
Name pastDueAt
Type null | Date
Description The date when the subscription became past due, or null
if the subscription is not past due.
Name pathRoot
Type string
Description The root path of the resource.
Name status
Type "active" | "past_due"
Description The current status of the subscription. Due to the free plan subscription item, the top level subscription can either be active
or past_due
.
Name subscriptionItems
Type BillingSubscriptionItemResource []
Description The list of subscription items included in this subscription.
Name updatedAt
Type null | Date
Description The date when the subscription was last updated, or null
if it hasn't been updated.
Last updated on Sep 30, 2025