Mayson Monorepo Documentation
    Preparing search index...
    Index

    Properties

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    currency_options?: {
        [key: string]: Stripe.ProductCreateParams.DefaultPriceData.CurrencyOptions;
    }

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

    When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.

    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.

    The recurring components of a price such as interval and interval_count.

    Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified. Once specified as either inclusive or exclusive, it cannot be changed.

    unit_amount?: number

    A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of unit_amount, unit_amount_decimal, or custom_unit_amount is required.

    unit_amount_decimal?: string

    Same as unit_amount, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of unit_amount and unit_amount_decimal can be set.