Mayson Monorepo Documentation
    Preparing search index...
    interface PriceUpdateParams {
        active?: boolean;
        currency_options?: Emptyable<
            { [key: string]: Stripe.PriceUpdateParams.CurrencyOptions },
        >;
        expand?: string[];
        lookup_key?: string;
        metadata?: Emptyable<MetadataParam>;
        nickname?: string;
        tax_behavior?: Stripe.PriceUpdateParams.TaxBehavior;
        transfer_lookup_key?: boolean;
    }
    Index

    Properties

    active?: boolean

    Whether the price can be used for new purchases. Defaults to true.

    currency_options?: Emptyable<
        { [key: string]: Stripe.PriceUpdateParams.CurrencyOptions },
    >

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

    expand?: string[]

    Specifies which fields in the response should be expanded.

    lookup_key?: string

    A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters.

    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.

    nickname?: string

    A brief description of the price, hidden from customers.

    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.

    transfer_lookup_key?: boolean

    If set to true, will atomically remove the lookup key from the existing price, and assign it to this price.