API reference · Catalog

Products and prices

Read client-visible products and their recurring or one-time price records.

Endpoints2

Primary objectProductObject

Tenant boundaryCredential studio

GET/products

List products

Lists products and nested price records. Active products are returned by default.

Required scope: catalog:read
Success: 200
Response: Page<ProductObject>

Parameters

activequery

boolean

Filter by active state. Defaults to true.

cursorquery

uuid

Opaque cursor returned by the previous page. Pass it back unchanged.

limitquery

integer

Number of records to return. Defaults to 50; maximum 200.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/products" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "object": "list",
  "data": [{
    "id": "7e3c7795-6be7-48c6-894e-cbbfb32c472d",
    "object": "product",
    "key": "five-class-pack",
    "name": "5-Class Pack",
    "product_type": "package",
    "active": true,
    "client_visible": true,
    "credits_granted": 5,
    "prices": [{
      "id": "5dbd1a97-07cc-4574-9346-86a479ea6df1",
      "amount": "165.00",
      "currency": "USD",
      "price_type": "one_time",
      "default": true,
      "active": true
    }]
  }],
  "has_more": false,
  "next_cursor": null
}

GET/products/{product_id}

Retrieve a product

Returns one product with all permitted price records.

Required scope: catalog:read
Success: 200
Response: ProductObject

Parameters

product_idpathrequired

uuid

The stable ClassFlow identifier for the product.

Example request

curl -X GET "https://api.getclassflow.com/partner/v1/products/YOUR_PRODUCT_ID" \
  -H "X-ClassFlow-Key: $CLASSFLOW_API_KEY"

Example response

200 · application/json

{
  "id": "7e3c7795-6be7-48c6-894e-cbbfb32c472d",
  "object": "product",
  "key": "five-class-pack",
  "name": "5-Class Pack",
  "product_type": "package",
  "active": true,
  "client_visible": true,
  "credits_granted": 5,
  "prices": [{
    "id": "5dbd1a97-07cc-4574-9346-86a479ea6df1",
    "amount": "165.00",
    "currency": "USD",
    "price_type": "one_time",
    "default": true,
    "active": true
  }]
}

Object schema

ProductObject

Full OpenAPI schema

iduuid

Stable product identifier.

keystring

Stable product key used by ClassFlow.

product_typestring

Product classification; not the billing cadence.

credits_grantedinteger | null

Credits granted by the product, when applicable.

pricesPriceObject[]

One-time and recurring prices. Use price_type and interval for cadence.