RecurringBilling Object

Information about the subscription item (if applicable).

Field NameTypeDescription
subscriptionIdstringUnique ID of the subscription.
subscriptionItemRunningNointegerRunning number of the item in the subscription.
subscriptionEventtypeIdintegerID that corresponds to the subscription event type. For more information, see Subscription Event Type.
originalPurchaseIdintegerUnique ID of the first purchase of the subscription.
originalPurchaseItemRunningNumberintegerRunning number of the item in the first purchase of the subscription.
intervalNumberintegerNumber of the last successfully paid interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one.
recurrenceCountintegerMaximum number of billings that can occur for the item.
gracePeriodDaysintegerThe number of days in which the customer can use the product during a grace period.
statusIdstringID that corresponds to the Status.
statusstringStatus of the subscription. For more information, see Subscription Statuses.
itemStatusIdstringID that corresponds to the Item Status.
itemStatusstringStatus of the subscription item. For more information, see Subscription Statuses.
nextBillingDatestringNext billing date according to RFC3339. Specified in UTC.
cancellationUrlstringURL where the customer can find the subscription cancellation page.
changePaymentSubscriptionUrlstringURL where the customer can find the change payment method page.
nextBillingProfitobjectFinancial figures related to the NextBillingDate. For more information, see ProfitCalculation Object.
renewalTypestringRenewal 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.
intervalLengthInMonthsintegerLength of the customer's current subscription billing period in months.
intervalLengthInDaysintegerLength of the customer's current subscription billing period in days.