Mayson Monorepo Documentation
    Preparing search index...

    Interface ProductData

    interface ProductData {
        active?: boolean;
        id?: string;
        metadata?: MetadataParam;
        name: string;
        statement_descriptor?: string;
        tax_code?: string;
        unit_label?: string;
    }
    Index

    Properties

    active? id? metadata? name statement_descriptor? tax_code? unit_label?

    Properties

    active?: boolean

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

    id?: string

    The identifier for the product. Must be unique. If not provided, an identifier will be randomly generated.

    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.

    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.

    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.

    Settings

    Member Visibility

    On This Page

    Properties