Mayson Monorepo Documentation
    Preparing search index...

    A Promotion Code represents a customer-redeemable code for an underlying promotion. You can create multiple codes for a single promotion.

    If you enable promotion codes in your customer portal configuration, then customers can redeem a code themselves when updating a subscription in the portal. Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.

    interface PromotionCode {
        id: string;
        object: "promotion_code";
        active: boolean;
        code: string;
        created: number;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        expires_at: number;
        livemode: boolean;
        max_redemptions: number;
        metadata: Metadata;
        promotion: Stripe.PromotionCode.Promotion;
        restrictions: Stripe.PromotionCode.Restrictions;
        times_redeemed: number;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "promotion_code"

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

    active: boolean

    Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.

    code: string

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

    created: number

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

    customer: string | Stripe.Customer | DeletedCustomer

    The customer who can use this promotion code.

    customer_account: string

    The account representing the customer who can use this promotion code.

    expires_at: number

    Date at which the promotion code can no longer be redeemed.

    livemode: boolean

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

    max_redemptions: number

    Maximum number of times this promotion code can be redeemed.

    metadata: Metadata

    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.

    times_redeemed: number

    Number of times this promotion code has been used.