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

Attributes
amount BigDecimal

The discount amount.

current_billing_cycle Integer

The 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 String

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

name String

The name of the discount.

never_expires? bool

A 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 Integer

Specifies the number of billing cycles of the discount.

quantity Integer

The 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.

Still have questions?

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