Mayson Monorepo Documentation
    Preparing search index...

    Interface ProductUpdateParams

    interface ProductUpdateParams {
        active?: boolean;
        default_price?: string;
        description?: string;
        expand?: string[];
        images?: Emptyable<string[]>;
        marketing_features?: Emptyable<
            Stripe.ProductUpdateParams.MarketingFeature[],
        >;
        metadata?: Emptyable<MetadataParam>;
        name?: string;
        package_dimensions?: Emptyable<
            Stripe.ProductUpdateParams.PackageDimensions,
        >;
        shippable?: boolean;
        statement_descriptor?: string;
        tax_code?: string;
        unit_label?: string;
        url?: string;
    }
    Index

    Properties

    active? default_price? description? expand? images? marketing_features? metadata? name? package_dimensions? shippable? statement_descriptor? tax_code? unit_label? url?

    Properties

    active?: boolean

    Whether the product is available for purchase.

    default_price?: string

    The ID of the Price object that is the default price for this product.

    description?: string

    The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    images?: Emptyable<string[]>

    A list of up to 8 URLs of images for this product, meant to be displayable to the customer.

    marketing_features?: Emptyable<Stripe.ProductUpdateParams.MarketingFeature[]>

    A list of up to 15 marketing features for this product. These are displayed in pricing tables.

    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

    The product's name, meant to be displayable to the customer.

    package_dimensions?: Emptyable<Stripe.ProductUpdateParams.PackageDimensions>

    The dimensions of this product for shipping purposes.

    shippable?: boolean

    Whether this product is shipped (i.e., physical goods).

    statement_descriptor?: string

    An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.

    This may be up to 22 characters. The statement description may not include <, >, \, ", ' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. It must contain at least one letter. May only be set if type=service. Only used for subscription payments.

    tax_code?: string

    A tax code ID.

    unit_label?: string

    A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if type=service.

    url?: string

    A URL of a publicly-accessible webpage for this product.

    Settings

    Member Visibility

    On This Page

    Properties