Skip to main content
GET
/
v1
/
product_groups
/
{id}
Retrieve
curl --request GET \
  --url https://{defaultHost}/v1/product_groups/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "f96469e2-9185-4465-a1d1-2a3a709ede77",
  "object": "product_group",
  "archived": false,
  "archived_at": null,
  "metadata": {},
  "name": "Membership - V1",
  "purchase_limit": null,
  "created_at": 1771429885,
  "updated_at": 1771429885
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
archived
boolean

Whether or not this product group is archived.

​
name
string

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

​
purchase_limit
integer | null

The max number of times the product group can be purchased by a customer. If null, then unlimited purchases are allowed.

​
metadata
object

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

​
archived_at
integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

​
products

Expandable – Property not returned unless expanded.

​
created_at
integer | null

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

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.