Product

A Product object represents something you sell in your store. Products contain metadata like name, description, and type, while pricing is managed through linked Offers. This separation allows a single product to have multiple pricing options for different regions or tiers. Products support various types including digital downloads, games, gift cards, software keys, subscriptions, and one-time payments. Each product can have variants (different versions) and, for subscriptions, billing plans.

Endpoints

Method	Endpoint	Description
`GET`	`/v0/products/list`	List and filter products
`POST`	`/v0/products/create`	Create a new product
`GET`	`/v0/products/{productId}`	Retrieve a product
`PATCH`	`/v0/products/{productId}/update`	Update a product
`PATCH`	`/v0/products/{productId}/archive`	Archive a product
`POST`	`/v0/products/{productId}/duplicate`	Duplicate a product
`POST`	`/v0/products/{productId}/variants/add`	Add a variant
`PATCH`	`/v0/products/{productId}/variants/{variantId}/update`	Update a variant
`PATCH`	`/v0/products/{productId}/variants/{variantId}/archive`	Archive a variant
`POST`	`/v0/products/{productId}/plans/add`	Add a subscription plan
`PATCH`	`/v0/products/{productId}/plans/{planId}/update`	Update a plan
`PATCH`	`/v0/products/{productId}/plans/{planId}/archive`	Archive a plan

The Product object

string

Object type identifier. Always "product" for Product objects.

string

required

Unique identifier (UUID) for this product.

string

required

Product type. Possible values: DigitalDownload, Game, GiftCard, SoftwareKey, VirtualCurrency, VirtualItem, Subscription, OneTimePayment

string

required

Display name of the product.

string

Product description. May contain HTML or markdown.

string | null

Your custom identifier for this product. Use to link to your own inventory system.

string

required

Product status. Possible values: DRAFT, ACTIVE, ARCHIVED

string | null

Game developer name (primarily for Game type products).

string | null

Game publisher name (primarily for Game type products).

integer | null

Unix timestamp (milliseconds) of the game’s release date.

string | null

PEGI age rating. Possible values: 3, 7, 12, 16, 18, ! (pending)

array | null

Supported platforms/systems. Possible values: Windows, MacOs, Linux, PlayStation 4, PlayStation 5, Xbox One, Xbox Series X|S, iOS, Android, Nintendo Switch, Nintendo 3DS

array | null

Game genres. Common values: Action, Adventure, RPG, FPS, Strategy, Simulation, Sports, Racing, Puzzle, Horror, Indie, MMO, Open World, Multiplayer

Product hierarchy

Example response

{
  "status": "success",
  "data": {
    "product": {
      "object": "product",
      "id": "bb0e8400-e29b-41d4-a716-446655440006",
      "type": "Game",
      "name": "Epic Adventure Quest",
      "description": "An immersive open-world RPG experience...",
      "internalId": "game_epic_adventure",
      "status": "ACTIVE",
      "developer": "Awesome Games Studio",
      "publisher": "Big Publisher Inc",
      "releaseDate": 1735689600000,
      "pegiRating": "16",
      "systems": ["Windows", "PlayStation 5", "Xbox Series X|S"],
      "genres": ["Action RPG", "Open World", "Adventure"]
    }
  }
}

Subscription product example

{
  "status": "success",
  "data": {
    "product": {
      "object": "product",
      "id": "cc0e8400-e29b-41d4-a716-446655440007",
      "type": "Subscription",
      "name": "Pro Membership",
      "description": "Unlock all premium features with our Pro plan",
      "internalId": "membership_pro",
      "status": "ACTIVE",
      "developer": null,
      "publisher": null,
      "releaseDate": null,
      "pegiRating": null,
      "systems": null,
      "genres": null
    }
  }
}

Offers

Pricing options for products

Discounts

Discounts applicable to products

Orders

Orders containing products

Subscriptions

Subscription products

Getting Started

Customers

Commerce

Transactions

Webhooks

Endpoints

The Product object

Product hierarchy

Example response

Subscription product example

Offers

Discounts

Orders

Subscriptions

​Endpoints

​The Product object

​Product hierarchy

​Example response

​Subscription product example

​Related resources

Offers

Discounts

Orders

Subscriptions

Endpoints

The Product object

Product hierarchy

Example response

Subscription product example

Related resources