Mayson Monorepo Documentation
    Preparing search index...

    Interface PromotionCodeCreateParams

    interface PromotionCodeCreateParams {
        promotion: Stripe.PromotionCodeCreateParams.Promotion;
        active?: boolean;
        code?: string;
        customer?: string;
        customer_account?: string;
        expand?: string[];
        expires_at?: number;
        max_redemptions?: number;
        metadata?: MetadataParam;
        restrictions?: Stripe.PromotionCodeCreateParams.Restrictions;
    }
    Index

    Properties

    The promotion referenced by this promotion code.

    active?: boolean

    Whether the promotion code is currently active.

    code?: string

    The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for a specific customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).

    If left blank, we will generate one automatically.

    customer?: string

    The customer who can use this promotion code. If not set, all customers can use the promotion code.

    customer_account?: string

    The account representing the customer who can use this promotion code. If not set, all customers can use the promotion code.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    expires_at?: number

    The timestamp at which this promotion code will expire. If the coupon has specified a redeems_by, then this value cannot be after the coupon's redeems_by.

    max_redemptions?: number

    A positive integer specifying the number of times the promotion code can be redeemed. If the coupon has specified a max_redemptions, then this value cannot be greater than the coupon's max_redemptions.

    metadata?: 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.

    Settings that restrict the redemption of the promotion code.