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 |
long | ✔️ | Unix timestamp (milliseconds) when the subscription became active. |
PastDueAt |
long | ✔️ | Unix timestamp (milliseconds) when the subscription became past due. |
SubscriptionItems |
List<CommerceSubscriptionItem> | ✔️ | Array of subscription items in this subscription. |
NextPayment |
CommerceSubscriptionNextPayment | ➖ | N/A |
EligibleForFreeTrial |
bool | ➖ | Whether the payer is eligible for a free trial. |