The SubscriptionItem object represents a specific product item within a subscription. It includes product details, pricing, lifecycle status, and promotion-related information.
| Field Name | Type | Description |
|---|---|---|
| runningNumber | integer | Running number of the item in the subscription. |
| quantity | integer | Quantity of the purchase item. |
| productId | integer | ID of the product. |
| productName | string | Product name used in customer communication. |
| productNameExtension | string | Additional naming information used in customer communication. |
| recurrenceCount | integer | Maximum number of billings that can occur for the item. |
| status | string | Status of the subscription. For more information, see Subscription Statuses. |
| deactivationDate | string | Date when the item was or will be deactivated; according to RFC3339. |
| startDate | string | Subscription start date according to RFC3339. |
| endDate | string | Number of the last successfully paid interval of the subscription item. Counting starts at 0. For each successfully paid interval, the number is increased by one. |
| isCurrent | boolean | Whether this item is currently active. |
| version | integer | Version number of the subscription item. |
| versionActiveDate | string | Date when the current version became active; according to RFC3339. |
| couponCode | string | Coupon code applied to the item for a promotion. |
| promotionId | integer | ID of the promotion to which the coupon code belongs. |
| subscriptionEventTypeId | string | Code of Subscription Event Type triggering this item. |
| yourRenewalPrice | object | Renewal pricing information that your company set up in the Cleverbridge platform for this item. For more information, see Prices Object. |
| customerRenewalPrice | object | Renewal pricing information that the customer receives during the purchase process for this item. For more information, see Prices Object . |