Mayson Monorepo Documentation
    Preparing search index...
    interface ProductData {
        description?: string;
        images?: string[];
        metadata?: MetadataParam;
        name: string;
        tax_code?: string;
        unit_label?: string;
    }
    Index

    Properties

    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.

    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.

    name: string

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

    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.