| Field | Type | Required | Description |
|---|---|---|---|
object |
CommerceSubscriptionItemObject | ✔️ | 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 |
CommerceSubscriptionItemStatus | ✔️ | Current status of the subscription item. |
credit |
Optional<CommerceSubscriptionCreditResponse> | ➖ | N/A |
credits |
JsonNullable<Credits> | ➖ | Unified credits breakdown for this subscription item. |
planId |
Optional<String> | ✔️ | Unique identifier for the associated plan. |
priceId |
Optional<String> | ➖ | Unique identifier for the associated price |
plan |
JsonNullable<Plan> | ➖ | The associated plan. |
planPeriod |
PlanPeriod | ✔️ | The billing period for this subscription item. |
paymentMethod |
Optional<CommercePaymentMethodResponse> | ➖ | N/A |
lifetimePaid |
Optional<CommerceMoneyResponse> | ➖ | N/A |
nextPayment |
JsonNullable<NextPayment> | ➖ | Information about the next payment. |
payerId |
String | ✔️ | Unique identifier for the payer. |
payer |
Optional<CommercePayerResponse> | ➖ | N/A |
isFreeTrial |
boolean | ✔️ | Whether this subscription item includes a free trial. |
periodStart |
long | ✔️ | Unix timestamp (in milliseconds) when the current period started. |
periodEnd |
Optional<Long> | ✔️ | Unix timestamp (in milliseconds) when the current period ends. |
prorationDate |
LocalDate | ➖ | The day the subscription item was prorated from. Only available in some responses. |
canceledAt |
Optional<Long> | ✔️ | Unix timestamp (in milliseconds) when the subscription item was canceled. |
pastDueAt |
Optional<Long> | ✔️ | Unix timestamp (in milliseconds) when the subscription item became past due. |
endedAt |
Optional<Long> | ✔️ | Unix timestamp (in milliseconds) when the subscription item ended. |
createdAt |
Optional<Long> | ➖ | Unix timestamp (in milliseconds) when the subscription item was created. |
updatedAt |
Optional<Long> | ➖ | Unix timestamp (in milliseconds) when the subscription item was last updated. |
seats |
JsonNullable<Seats> | ➖ | Seat quantity for seat-based billing. |
totals |
JsonNullable<Totals> | ➖ | Totals for this subscription item. |