Mayson Monorepo Documentation
    Preparing search index...

    Interface CouponCreateParams

    interface CouponCreateParams {
        amount_off?: number;
        applies_to?: Stripe.CouponCreateParams.AppliesTo;
        currency?: string;
        currency_options?: {
            [key: string]: Stripe.CouponCreateParams.CurrencyOptions;
        };
        duration?: Stripe.CouponCreateParams.Duration;
        duration_in_months?: number;
        expand?: string[];
        id?: string;
        max_redemptions?: number;
        metadata?: Emptyable<MetadataParam>;
        name?: string;
        percent_off?: number;
        redeem_by?: number;
    }
    Index

    Properties

    amount_off? applies_to? currency? currency_options? duration? duration_in_months? expand? id? max_redemptions? metadata? name? percent_off? redeem_by?

    Properties

    amount_off?: number

    A positive integer representing the amount to subtract from an invoice total (required if percent_off is not passed).

    applies_to?: Stripe.CouponCreateParams.AppliesTo

    A hash containing directions for what this Coupon will apply discounts to.

    currency?: string

    Three-letter ISO code for the currency of the amount_off parameter (required if amount_off is passed).

    currency_options?: { [key: string]: Stripe.CouponCreateParams.CurrencyOptions }

    Coupons defined in each available currency option (only supported if amount_off is passed). Each key must be a three-letter ISO currency code and a supported currency.

    duration?: Stripe.CouponCreateParams.Duration

    Specifies how long the discount will be in effect if used on a subscription. Defaults to once.

    duration_in_months?: number

    Required only if duration is repeating, in which case it must be a positive integer that specifies the number of months the discount will be in effect.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    id?: string

    Unique string of your choice that will be used to identify this coupon when applying it to a customer. If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.

    max_redemptions?: number

    A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.

    metadata?: Emptyable<MetadataParam>

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    name?: string

    Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the id is shown if name is not set.

    percent_off?: number

    A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if amount_off is not passed).

    redeem_by?: number

    Unix timestamp specifying the last time at which the coupon can be redeemed (cannot be set to more than 5 years in the future). After the redeem_by date, the coupon can no longer be applied to new customers.

    Settings

    Member Visibility

    On This Page

    Properties