Skip to main content
GET
Retrieve a product group

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

The product group ID

Response

The product group

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

String representing the object's type. Objects of the same type share the same value.

Example:

"product_group"

name
string
required

The name of the product group.

description
string | null
required

A description of the product group.

external_id
string | null
required

Your own key for this product group, or null when it has none.

products
object[]
required

The products in the group, in display order. A product is in one group at a time.

upgrades_enabled
boolean
required

Whether customers can switch between the products of this group.

upgrade_behavior
enum<string> | null
required

How a switch between the products is billed, or null for the default.

Available options:
proration-charge-immediately,
proration-charge,
proration-none
upsells_enabled
boolean
required

Whether the products of this group are offered as checkout upsells.

is_active
boolean
required

Whether the product group is active. Stored and returned; it does not yet stop upgrades or upsells.

created_at
string<date-time>
required

Creation date of the product group.

Example:

"2023-01-01T00:00:00Z"

updated_at
string<date-time>
required

Last updated date of the product group.

Example:

"2023-01-01T00:00:00Z"