SchemasCommerceSubscriptionItem.md

SchemasCommerceSubscriptionItem

A commerce subscription item.

Fields

Field	Type	Required	Description
object	SchemasCommerceSubscriptionItemObject	✔️	String representing the object's type. Objects of the same type share the same value.
id	String	✔️	Unique identifier for the subscription item.
instanceId	String	✔️	Unique identifier for the Clerk instance.
status	SchemasCommerceSubscriptionItemStatus	✔️	Current status of the subscription item.
credit	JsonNullable<Credit>	➖	Credit information (only available in PaymentAttempt events).
planId	String	✔️	Unique identifier for the associated plan.
priceId	Optional<String>	➖	Unique identifier for the associated price
plan	Optional<SchemasCommerceSubscriptionItemPlan>	✔️	The associated commerce plan.
planPeriod	SchemasCommerceSubscriptionItemPlanPeriod	✔️	The billing period for this subscription.
paymentSourceId	String	✔️	Unique identifier for the payment source.
paymentSource	JsonNullable<PaymentSource>	➖	The payment source associated with this subscription.
lifetimePaid	JsonNullable<LifetimePaid>	➖	Total amount paid over the lifetime of this subscription.
amount	JsonNullable<SchemasCommerceSubscriptionItemAmount>	➖	Current amount for this subscription.
nextInvoice	JsonNullable<NextInvoice>	➖	Information about the next invoice.
nextPayment	JsonNullable<SchemasCommerceSubscriptionItemNextPayment>	➖	Information about the next payment.
payerId	String	✔️	Unique identifier for the payer.
payer	JsonNullable<Payer>	➖	The payer associated with this subscription.
isFreeTrial	boolean	✔️	Whether this subscription is currently on a free trial.
periodStart	JsonNullable<Long>	➖	Unix timestamp (in milliseconds) when the current period started.
periodEnd	JsonNullable<Long>	➖	Unix timestamp (in milliseconds) when the current period ends.
prorationDate	String	✔️	Date used for proration calculations.
canceledAt	JsonNullable<Long>	➖	Unix timestamp (in milliseconds) when the subscription was canceled.
pastDueAt	JsonNullable<Long>	➖	Unix timestamp (in milliseconds) when the subscription became past due.
endedAt	JsonNullable<Long>	➖	Unix timestamp (in milliseconds) when the subscription ended.
createdAt	long	✔️	Unix timestamp (in milliseconds) when the subscription was created.
updatedAt	long	✔️	Unix timestamp (in milliseconds) when the subscription was last updated.