Core Resources
Payment Methods
Money Management
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

The Coupon object 

Products
Coupons
The Coupon object

Attributes

  • idstring

    Unique identifier for the object.

  • amount_offnullable integer

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

  • currencynullable enum

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

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

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

  • namenullable string

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

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

More attributes

  • objectstring

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

  • applies_tonullable objectExpandable

    Contains information about what this coupon applies to.

    • applies_to.productsarray of strings

      A list of product IDs this coupon applies to

  • createdtimestamp

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

  • currency_optionsnullable objectExpandable

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

    • currency_options.<currency>.amount_offinteger

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

  • duration_in_monthsnullable integerDeprecated

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

  • livemodeboolean

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

  • max_redemptionsnullable integer

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

  • redeem_bynullable timestamp

    Date after which the coupon can no longer be redeemed.

  • times_redeemedinteger

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

  • validboolean

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

The Coupon object
{
  "id": "jMT0WJUD",
  "object": "coupon",
  "amount_off": null,
  "created": 1678037688,
  "currency": null,
  "duration": "repeating",
  "duration_in_months": 3,
  "livemode": false,
  "max_redemptions": null,
  "metadata": {},
  "name": null,
  "percent_off": 25.5,
  "redeem_by": null,
  "times_redeemed": 0,
  "valid": true
}