Subscription Model

meta

object

Metadata related to the notification. For more information, see Meta Object.

subscriptionId

integer

Unique ID of the subscription.

customerCurrencyId

string

ID of the customer’s currency (e.g., USD, EUR).

customerId

integer

Unique ID of the customer.

customerReferenceId

string

Internal customer reference ID.

customerReferenceNo

string

Your unique ID for the customer. This value is submitted by you when the customer initially purchases a product and is stored by Cleverbridge. Corresponds to the Internal customer ID in the Commerce Assistant. It can be used to identify the customer and auto-process the order. For more information, see Internal Customer Data.

gracePeriodDays

integer

The number of days in which the customer can use the product during a grace period.

billingIntervalDayCount

integer

Number of days in the billing interval.

billingIntervalMonthCount

integer

Number of months in the billing interval.

intervalDayCount

integer

Number of days in the general interval.

intervalMonthCount

integer

Number of months in the general interval.

lastBillingIntervalNumber

integer

Number of the last billed interval of the subscription. Counting starts at 0. For each successfully paid interval, the number is increased by one.

lastIntervalNumber

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.

nextBillingDate

string

Next billing date according to RFC3339 . Specified in UTC.

nextRenewalDate

string

Next expected renewal date according to RFC3339.

nextBillingDateReminder

string

Reminder date prior to next billing according to RFC3339.

startDate

string

Subscription start date according to RFC3339.

endDate

string

Subscription end date according to RFC3339 .

managementModel

string

Model used to manage subscription (e.g., self-managed, assisted).

renewalType

string

Type of renewal applied (e.g., manual, auto).

startIntervalDayCount

integer

Start interval in days.

startIntervalMonthCount

integer

Start interval in months.

subscriptionStatus

string

Current status of the subscription.

cartCouponCode

string

Coupon code applied to the cart for a promotion.

cartPromotionId

integer

ID of the promotion to which the coupon code belongs.

cartPromotionName

string

Name of the promotion to which the coupon code belongs.

packageDiscountId

integer

ID of the package discount applied.

packageDiscountName

string

The name of the package discount applied.

packagePriceConfigurationId

integer

ID of the package pricing configuration.

packagePriceConfigurationName

string

Name of the package pricing configuration.

yourRenewalPrice

object

Renewal pricing information that your company set up in the Cleverbridge platform for this subscription. For more information, see Price Object.

customerRenewalPrice

object

Renewal pricing information that the customer receives during the purchase process for this subscription. For more information, see Price Object .

subscriptionPurchase

object

Basic purchase details linked to this subscription. For more information, see SubscriptionPurchase Object.

subscriptionItems

array of objects

List of current Subscription Item Objects .

previousSubscriptionItems

array of objects

List of previously active Subscription Item Objects .