Objects

The Discount object

Fields of the Discount object.

Attributes

• id string required
• code string required
• name string nullable
• type string required

  One of percentage fixed

• value string required

  A percentage, or an amount in the currency of the code

• currency string nullable

  Only for a fixed amount

• duration string required

  How many payments of a subscription get the discount: the first, the first duration_periods, or every payment

  One of once repeating forever

• duration_periods integer nullable
• all_links boolean required

  Valid for every payment link, or only for the links in links

• links array of strings

  Ids of the payment links the code is limited to

• max_redemptions integer nullable

  How often the code can be used in total, by all customers together

• times_redeemed integer
• once_per_customer boolean
• starts_at string nullable
• expires_at string nullable
• is_active boolean required
• status string required

  One of active inactive scheduled expired used_up

• created_at string required