CreateProductRequest

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

activeProduct-Active

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"}

CreateProductRequest

{
  "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",
  "active": true,
  "metadata": {
    "systemId": "12345"
  }
}