Get a product group

Get a product group by ID.

^{Required permissions: product-group:read}

GET /catalogue/product-groups/{id}

cURL

cURL

curl -X GET \
 /catalogue/product-groups/{id} \
 --header "Authorization: Bearer <token>"

200

{
  "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
  "name": "SaaS Packages",
  "enabled": true,
  "forceSameBillingInterval": false,
  "memberships": [
    {
      "id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
      "product": "<unknown>",
      "pricePlans": [
        "<unknown>"
      ],
      "position": 123,
      "label": "Pro",
      "upgradeable": true,
      "downgradeable": true
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Get a single product group by ID.

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

id · string · erforderlich

ProductGroup identifier

Antwort

200

application/json

ProductGroup resource

A product group for up- and downgrades

id · string · read-only

Beispiel:

"ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b"

name · string

Beispiel:

"SaaS Packages"

enabled · boolean

Beispiel:

true

forceSameBillingInterval · boolean

If true, customers can only switch between plans with the same billing interval

Beispiel:

false

memberships · object[]

Show child attributes

createdAt · string<date-time> · read-only

updatedAt · string<date-time> · read-only