Discountanchor

Server-side response object returned directly or within a successful result object from the following requests:
Attributes
getAmount()BigDecimal

The discount amount.

getCreatedAt()Calendar

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

getCurrentBillingCycle()int

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

getDescription()string

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

getKind()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 null for discounts that are attached to a subscription.

getName()string

The name of the discount.

isNeverExpires()boolean

A value indicating whether a discount's billing cycle is set to never expire instead of running for a specific number of billing cycles.

getNumberOfBillingCycles()int

Specifies the number of billing cycles of the discount.

getQuantity()int

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

getUpdatedAt()Calendar

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