Add On
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountBigDecimalThe add-on amount.
created_atTimeThe date/time the add-on was created. Returned in UTC.
current_billing_cycleIntegerThe 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.
descriptionStringA description of the add-on. Its value will always be nil for add-ons that are attached to a subscription.
idStringThe add-on identifier. Length and format of gateway-generated tokens and IDs may change at any time.
kindStringThe 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.
nameStringThe name of the add-on.
never_expires?boolA 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_cyclesIntegerSpecifies the number of billing cycles of the add-on.
quantityIntegerThe 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.
updated_atTimeThe date/time the add-on was last updated. Returned in UTC.