The Discount object 

Attributes

• idstring

  The ID of the discount object. Discounts cannot be fetched by ID. Use expand[]=discounts in API calls to expand discount IDs in an array.

• couponobject

  Hash describing the coupon applied to create this discount.

  Hide child attributes

  • coupon.idstring

    Unique identifier for the object.

  • coupon.objectstring

    String representing the object’s type. Objects of the same type share the same value.

  • coupon.amount_offnullable integer

    Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

  • coupon.applies_tonullable objectExpandable

    Contains information about what this coupon applies to.

    Hide child attributes

    • coupon.applies_to.productsarray of strings

      A list of product IDs this coupon applies to

  • coupon.createdtimestamp

    Time at which the object was created. Measured in seconds since the Unix epoch.

  • coupon.currencynullable enum

    If amount_off has been set, the three-letter ISO code for the currency of the amount to take off.

  • coupon.currency_optionsnullable objectExpandable

    Coupons defined in each available currency option. Each key must be a three-letter ISO currency code and a supported currency.

    Hide child attributes

    • coupon.currency_options.<currency>.amount_offinteger

      Amount (in the currency specified) that will be taken off the subtotal of any invoices for this customer.

  • coupon.durationenum

    One of forever, once, or repeating. Describes how long a customer who applies this coupon will get the discount.

    Possible enum values

    forever Applies to all charges from a subscription with this coupon applied.

    once Applies to the first charge from a subscription with this coupon applied.

    repeating Applies to charges in the first duration_in_months months from a subscription with this coupon applied. This value is deprecated and will be replaced in future versions of the API.

  • coupon.duration_in_monthsnullable integerDeprecated

    If duration is repeating, the number of months the coupon applies. Null if coupon duration is forever or once.

  • coupon.livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • coupon.max_redemptionsnullable integer

    Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.

  • coupon.metadatanullable object

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

  • coupon.namenullable string

    Name of the coupon displayed to customers on for instance invoices or receipts.

  • coupon.percent_offnullable float

    Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $100 invoice $50 instead.

  • coupon.redeem_bynullable timestamp

    Date after which the coupon can no longer be redeemed.

  • coupon.times_redeemedinteger

    Number of times this coupon has been applied to a customer.

  • coupon.validboolean

    Taking account of the above properties, whether this coupon can still be applied to a customer.

• customernullable stringExpandable

  The ID of the customer associated with this discount.

• endnullable timestamp

  If the coupon has a duration of repeating, the date that this discount will end. If the coupon has a duration of once or forever, this attribute will be null.

• starttimestamp

  Date that the coupon was applied.

• subscriptionnullable string

  The subscription that this coupon is applied to, if it is applied to a particular subscription.

More attributes

Collapse all

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• checkout_sessionnullable string

  The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.

• invoicenullable string

  The invoice that the discount’s coupon was applied to, if it was applied directly to a particular invoice.

• invoice_itemnullable string

  The invoice item id (or invoice line item id for invoice line items of type=‘subscription’) that the discount’s coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.

• promotion_codenullable stringExpandable

  The promotion code applied to create this discount.

• subscription_itemnullable string

  The subscription item that this coupon is applied to, if it is applied to a particular subscription item.