Returned within a successful result object from the following requests:

Attributes
amount String

The add-on amount.

currentBillingCycle int

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.

description string

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

kind string

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.

name string

The name of the add-on.

neverExpires bool

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.

numberOfBillingCycles int

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

quantity int

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.

Still Have Questions?

If you can’t find an answer, give us a call at 877.434.2894 or contact our Support team