Server-Side Response Objects/
Discount

Discount

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
amountBigDecimal

The discount amount.

created_atTime

The date/time the discount was created. Returned in UTC.

current_billing_cycleInteger

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.

descriptionString

A description of the discount. Its value will always be nil for discounts that are attached to a subscription.

kindString

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.

nameString

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_cyclesInteger

Specifies the number of billing cycles of the discount.

quantityInteger

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.

updated_atTime

The date/time the discount was last updated. Returned in UTC.