Products

A Product represents an offering that is offered by a merchant for their customers.

Product Resource

{
    "data": {
        "id": "prdct_a0198f3927353ba99af2f135",
        "account_id": "acct_1234567890",
        "external_code": "sku_001",
        "name": "laptop",
        "description": "cool looking laptop",
        "type": "physical_good",
        "status": "active",
        "images": [
            "file_123123"
        ],
        "metadata": {
            "clock_speed": 1.23,
            "cores": 100,
            "cpu": "intel i9-9999k"
        },
        "prices": null,
        "created_at": 1755078183,
        "updated_at": 1755078183
    }
}

Fields

id string

Unique ID of the product.

account_id string

Account ID of the owner of the product.

external_code string

Nickname of the product, meant to be used in aiding merchants to identify their products.

name string

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

Max 255 chars long.

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.

Max 1000 chars long.

type string enum

Type of the product. Possible values are physical_good , digital_good and service.

status string enum

Status of the product. Affects how the product is shown to customers. Possible values are active, inactive, coming_soon, out_of_stock.

images array

List of files IDs from Files API that are images of the product.

Max 10 images.

metadata dictionary

A set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the object in a structured format.

Nesting is currently not supported, up to 50 key-value pairs may be inserted for the product. Keys are 50 chars max, while string values are 500 chars max.

price array

A positive integer in cents (or 0 for a free price) representing how much to charge.

currency string

Three-letter ISO currency code, in uppercase. Must be a supported currency.

created_at timestamp

The unix timestamp when the product was created

updated_at timestamp

The unix timestamp when the product was last updated