Discount
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountStringThe discount amount.
createdAtStringThe date/time the discount was created. Returned in UTC.
currentBillingCycleNumberThe discount's current billing cycle. It is incremented each time the discount is successfully applied. Its value will always be null for discounts that are not attached to a subscription.
descriptionStringA description of the discount. Its value will always be null for discounts that are attached to a subscription.
idStringThe discount 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 null for discounts that are attached to a subscription.
nameStringThe name of the discount.
neverExpiresboolA value indicating whether a discount's billing cycle is set to never expire instead of running for a specific number of billing cycles.
numberOfBillingCyclesNumberSpecifies the number of billing cycles of the discount.
quantityNumberThe number of times this particular discount is applied to the subscription. Its value will always be null for discounts that are not attached to a subscription.
updatedAtStringThe date/time the discount was last updated. Returned in UTC.