Discount
Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amount
BigDecimalThe discount amount.
created_at
TimeThe date/time the discount was created. Returned in UTC.
current_billing_cycle
IntegerThe discount's current billing cycle. It is incremented each time the discount is successfully applied. Its value will always be nil for discounts that are not attached to a subscription.
description
StringA description of the discount. Its value will always be nil for discounts that are attached to a subscription.
id
StringThe discount identifier. Length and format of gateway-generated tokens and IDs may change at any time.
kind
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 nil for discounts that are attached to a subscription.
name
StringThe name of the discount.
never_expires?
boolA value indicating whether a discount's billing cycle is set to never expire instead of running for a specific number of billing cycles.
number_of_billing_cycles
IntegerSpecifies the number of billing cycles of the discount.
quantity
IntegerThe number of times this particular discount is applied to the subscription. Its value will always be nil for discounts that are not attached to a subscription.
updated_at
TimeThe date/time the discount was last updated. Returned in UTC.