Mayson Monorepo Documentation
    Preparing search index...

    Interface Product

    Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

    Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices

    interface Product {
        id: string;
        object: "product";
        active: boolean;
        created: number;
        default_price?: string | Stripe.Price;
        deleted?: void;
        description: string;
        images: string[];
        livemode: boolean;
        marketing_features: Stripe.Product.MarketingFeature[];
        metadata: Metadata;
        name: string;
        package_dimensions: Stripe.Product.PackageDimensions;
        shippable: boolean;
        statement_descriptor?: string;
        tax_code?: string | TaxCode;
        type: Stripe.Product.Type;
        unit_label?: string;
        updated: number;
        url: string;
    }
    Index

    Properties

    id object active created default_price? deleted? description images livemode marketing_features metadata name package_dimensions shippable statement_descriptor? tax_code? type unit_label? updated url

    Properties

    id: string

    Unique identifier for the object.

    object: "product"

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

    active: boolean

    Whether the product is currently available for purchase.

    created: number

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

    default_price?: string | Stripe.Price

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

    deleted?: void

    Always true for a deleted object

    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.

    images: string[]

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

    livemode: boolean

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

    marketing_features: Stripe.Product.MarketingFeature[]

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

    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.

    name: string

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

    package_dimensions: Stripe.Product.PackageDimensions

    The dimensions of this product for shipping purposes.

    shippable: boolean

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

    statement_descriptor?: string

    Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.

    tax_code?: string | TaxCode

    A tax code ID.

    type: Stripe.Product.Type

    The type of the product. The product is either of type good, which is eligible for use with Orders and SKUs, or service, which is eligible for use with Subscriptions and Plans.

    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.

    updated: number

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

    url: string

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

    Settings

    Member Visibility

    On This Page

    Properties