Returned directly or within a successful result object from the following requests:

Attributes
amount BigDecimal

The add-on amount.

current_billing_cycle Integer

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

description String

A description of the add-on. Its value will always be nil 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 nil for add-ons that are attached to a subscription.

name String

The name of the add-on.

never_expires? 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.

number_of_billing_cycles Integer

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

quantity Integer

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

Still have questions?

If you can’t find an answer, contact our Support team