Server-Side Response Objects/
Add-On

Add On

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountString

The add-on amount.

createdAtString

The date/time the add-on was created. Returned in UTC.

currentBillingCycleNumber

The add-on's current billing cycle. It is incremented each time the add-on is successfully applied. Its value will always be null for add-ons that are not attached to a subscription.

descriptionString

A description of the add-on. Its value will always be null for add-ons that are attached to a subscription.

kindString

The value that defines whether the modification being applied to a plan or subscription is an add-on or a discount. Its value will always be null for add-ons that are attached to a subscription.

nameString

The name of the add-on.

neverExpiresbool

A value indicating whether an add-on's billing cycle is set to never expire instead of running for a specific number of billing cycles.

numberOfBillingCyclesNumber

Specifies the number of billing cycles of the add-on.

quantityNumber

The number of times this particular add-on is applied to the subscription. Its value will always be null for add-ons that are not attached to a subscription.

updatedAtString

The date/time the add-on was last updated. Returned in UTC.