A commerce subscription.
| Field | Type | Required | Description |
|---|---|---|---|
object |
CommerceSubscriptionObject | ✔️ | String representing the object's type. Objects of the same type share the same value. |
id |
String | ✔️ | Unique identifier for the commerce subscription. |
instanceId |
String | ✔️ | The ID of the instance this subscription belongs to. |
status |
CommerceSubscriptionStatus | ✔️ | The current status of the subscription. |
payerId |
String | ✔️ | The ID of the payer for this subscription. |
createdAt |
long | ✔️ | Unix timestamp (milliseconds) of creation. |
updatedAt |
long | ✔️ | Unix timestamp (milliseconds) of last update. |
activeAt |
Optional<Long> | ✔️ | Unix timestamp (milliseconds) when the subscription became active. |
pastDueAt |
Optional<Long> | ✔️ | Unix timestamp (milliseconds) when the subscription became past due. |
subscriptionItems |
List<CommerceSubscriptionItem> | ✔️ | Array of subscription items in this subscription. |
nextPayment |
Optional<CommerceSubscriptionNextPayment> | ➖ | N/A |
eligibleForFreeTrial |
Optional<Boolean> | ➖ | Whether the payer is eligible for a free trial. |