Mayson Monorepo Documentation
    Preparing search index...

    Interface ProductCreateParams

    interface ProductCreateParams {
        name: string;
        active?: boolean;
        default_price_data?: Stripe.ProductCreateParams.DefaultPriceData;
        description?: string;
        expand?: string[];
        id?: string;
        images?: string[];
        marketing_features?: Stripe.ProductCreateParams.MarketingFeature[];
        metadata?: MetadataParam;
        package_dimensions?: Stripe.ProductCreateParams.PackageDimensions;
        shippable?: boolean;
        statement_descriptor?: string;
        tax_code?: string;
        type?: Stripe.ProductCreateParams.Type;
        unit_label?: string;
        url?: string;
    }
    Index

    Properties

    name active? default_price_data? description? expand? id? images? marketing_features? metadata? package_dimensions? shippable? statement_descriptor? tax_code? type? unit_label? url?

    Properties

    name: string

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

    active?: boolean

    Whether the product is currently available for purchase. Defaults to true.

    default_price_data?: Stripe.ProductCreateParams.DefaultPriceData

    Data used to generate a new Price object. This Price will be set as 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.

    id?: string

    An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.

    images?: string[]

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

    marketing_features?: Stripe.ProductCreateParams.MarketingFeature[]

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

    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.

    package_dimensions?: Stripe.ProductCreateParams.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. Only used for subscription payments.

    tax_code?: string

    A tax code ID.

    type?: Stripe.ProductCreateParams.Type

    The type of the product. Defaults to service if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to good to use this product with Orders and SKUs. On API versions before 2018-02-05, this field defaults to good for compatibility reasons.

    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.

    url?: string

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

    Settings

    Member Visibility

    On This Page

    Properties