Add On
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
getAmount()BigDecimalThe add-on amount.
getCreatedAt()CalendarThe date/time the add-on was created. Returned in UTC.
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.
getDescription()stringA description of the add-on. Its value will always be null for add-ons that are attached to a subscription.
getId()stringThe add-on identifier. Length and format of gateway-generated tokens and IDs may change at any time.
getKind()stringThe 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.
getName()stringThe name of the add-on.
isNeverExpires()booleanA value indicating whether an add-on's billing cycle is set to never expire instead of running for a specific number of billing cycles.
Specifies the number of billing cycles of the add-on.
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.
getUpdatedAt()CalendarThe date/time the add-on was last updated. Returned in UTC.