Information about the subscription item (if applicable).
Field Name | Type | Description |
---|---|---|
subscriptionId | string | Unique ID of the subscription. |
subscriptionItemRunningNo | integer | Running number of the item in the subscription. |
subscriptionEventtypeId | string | ID that corresponds to the subscription event type. For more information, see Subscription Event Type. |
originalPurchaseId | integer | Unique ID of the first purchase of the subscription. |
originalPurchaseItemRunningNumber | integer | Running number of the item in the first purchase of the subscription. |
intervalNumber | integer | 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. |
subscriptionIntervalNumber | integer | Number of the last successfully paid interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one. |
recurrenceCount | integer | Maximum number of billings that can occur for the item. |
gracePeriodDays | integer | The number of days in which the customer can use the product during a grace period. |
statusId | string | ID that corresponds to the Status . |
status | string | Status of the subscription. For more information, see Subscription Statuses. |
itemStatusId | string | ID that corresponds to the Item Status . |
itemStatus | string | Status of the subscription item. For more information, see Subscription Statuses. |
nextBillingDate | string | Next billing date according to RFC3339. Specified in UTC. |
cancellationUrl | string | URL where the customer can find the subscription cancellation page. |
changePaymentSubscriptionUrl | string | URL where the customer can find the change payment method page. |
nextBillingProfit | object | Financial figures related to the NextBillingDate . For more information, see ProfitCalculation Object. |
renewalType | string | Renewal type of the subscription. With Automatic , the subscription automatically renews at the end of the billing interval using the billing information provided by the customer. With Manual , the customer must initiate the renewal at the end of the billing interval. |
intervalLengthInMonths | integer | Length of the customer's current subscription billing period in months. |
intervalLengthInDays | integer | Length of the customer's current subscription billing period in days. |