V2
This topic shows information relevant specifically for Subscribe REST API version 20210401 referred to as V2Attributes
| Name | Type | Description |
|---|---|---|
| object | string | Value is “SubscriptionItem” |
| id | string | A merchant-specified unique identifier. Optionally, this object can be identified by its vid. We strongly recommend specifying an item-level id. |
| vid | string | A Globally Unique Identifier (GUID) for this object. This field is created by Subscribe. |
| index | integer | Sequential index of all items on the subscription. |
| product | Product | The predefined SKU of the product billed by this item. |
| amount | decimal | The unit price of the item. |
| currency | string | ISO 4217 Currency Code of this item. |
| rate_plan | Rate Plan | For rated products, the governing rate_plan |
| metadata | hash | A set of key/value pairs that you can attach to an object. Useful for storing additional information. |
| quantity | decimal | The unit quantity for the item; for license-based products this is the license/seat quantity. |
| campaign_code | string | Campaign code id to be redeemed by the Subscription Item. See Campaign Codes for details. |
| campaign_id | Campaigns | The campaign being redeemed by the Subscription Item. See Campaigns for details. |
| discount_tickets | Discount Tickets | Discount Tickets offer the ability to redeem multiple campaign discounts. This attribute is an array of Discount Tickets applicable to this subscription item. |
| token | Token | Token associated with amount (if this is a Token-based Subscription). This value will be ignored if amount is null. |
| cycles | integer | The number of billing cycles for which this item should bill (0 = life of the Subscription). |
| cycles_remaining | integer | If a billing cycle limit is defined, this is the number of billing cycles left to bill. |
| created | datetime | The datetime this item was added to the subscription. |
| ends | datetime | The datetime this item was removed from the subscription (end of service). |
| starts | datetime | The datetime this item was effective/started on the subscription (start of service). |
| replaces | Subscription Item | SubscriptionItem replaced by this item. |
| replaced_by | Subscription Item | SubscriptionItem which replaced this item. |