ProductList

items object[]required

The products in this page, newest first.

Array [

idstring<uuid>required

Unique identifier for the product.

Example: 8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60

nameProduct-Namerequired

The name of the product.

Possible values: non-empty and <= 100 characters

Example: Gold plan

descriptionProduct-Description

A description of the product.

Possible values: <= 1000 characters

Example: Unlimited access to every course

imagesstring<uri>[]

Up to 8 image URLs of the product. Each URL must use https.

Possible values: <= 8

slugProduct-Slug

A short name of the product: lowercase letters and digits, joined by single hyphens.

A slug is unique in your account. A request that sets a slug another product already has is rejected with 409. An archived product keeps its slug until you remove it.

Possible values: <= 100 characters, Value must match regular expression ^[a-z0-9]+(-[a-z0-9]+)*$

Example: gold-plan

shippableProduct-Shippable

Whether the product is shipped to the buyer.

Example: false

unitLabelProduct-UnitLabel

The name of one unit of the product, for example seat or hour.

Possible values: <= 12 characters

Example: seat

descriptorProduct-Descriptor

A statement descriptor stored on the product and returned in its responses. It is not applied to payments or subscriptions yet: set descriptor on the subscription instead.

Possible values: <= 25 characters

Example: MONEI GOLD

defaultPriceIdstring<uuid>

The default price of the product. It is always a price of this product. You set it with Update Product, after you create the price.

Example: 3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13

activeProduct-Activerequired

Whether the product is active. Products are never deleted: set active to false to archive one. Archiving a product does not archive its prices, and its prices can still start subscriptions.

Default value: true

Example: true

metadataobject

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

Example: {"systemId":"12345"}

createdAtinteger<int64>required

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

Example: 1636366897

updatedAtinteger<int64>

Time at which the resource updated last time. Measured in seconds since the Unix epoch.

Example: 1636366897

]

nextCursorNextCursor

Pass this value as cursor to get the next page. Absent when there are no more items. The last page can still carry it, and the next call then returns no items.

Example: eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ

ProductList

{
  "items": [
    {
      "id": "8f2c6d1a-4b3e-4f7a-9d2c-1e5b7a9c3f60",
      "name": "Gold plan",
      "description": "Unlimited access to every course",
      "images": [
        "https://example.com/images/gold-plan.png"
      ],
      "slug": "gold-plan",
      "shippable": false,
      "unitLabel": "seat",
      "descriptor": "MONEI GOLD",
      "defaultPriceId": "3c5a1f8e-2b7d-4e9a-9c41-7d2e6b0f5a13",
      "active": true,
      "metadata": {
        "systemId": "12345"
      },
      "createdAt": 1636366897,
      "updatedAt": 1636366897
    }
  ],
  "nextCursor": "eyJpZCI6IjhmMmM2ZDFhIiwiY3JlYXRlZEF0IjoxNzYxMjE0NDAwfQ"
}