Offerings catalog

Course Types

A CourseType represents an offering type.

get/shop/course-types/{courseTypeId}

Update a course type

updateCourseType

Partially updates a CourseType. Every field is optional; only fields you send are written. Fields you omit retain their current values.

If the course type does not yet have a coupon_id (legacy course types from earlier versions of the API), one is provisioned on first update so future redemptions can be tracked. The coupon's name is kept in sync with <name> credit automatically.

Requires the SETTINGS_MANAGE permission on the course type's site.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Request body

namestringoptional
Display name for the course type.
currencystringoptional
The ISO-4217 currency code.
descriptionstringoptionalnullable
Markdown-rendered long-form description shown to customers when they're selecting the course type.
product_codestringoptionalnullable
Optional product code used to map this course type to an external POS or PMS catalog.
external_idstringoptionalnullable
External identifier used by integrations to reference this offering. Free-form.
offered_onlinebooleanoptional
When true, this course type can be purchased via the public shopfront.
privatebooleanoptional
When true, the course type is hidden from the public shopfront listing but remains purchasable via direct link.
visibilitystringoptional
The visibility status of the product.
Possible values:publiclink_onlyprivate
offering_typestringoptional
Deprecated. Legacy single-offering type pointer; new callers populate offerings instead. See CreateCourseType.
Possible values:area_bookingappointmentproductsession
offering_idobject-idoptionalnullable
Deprecated. Legacy single-offering ID; new callers populate offerings instead.
offeringsobject[]optional
upsell_offeringsobject[]optional
cross_sell_offeringsobject[]optional
related_retail_offeringsobject[]optional
metaobjectoptional
SEO meta-overrides for the course type's shopfront page.
quantityintegeroptional
Number of credits the course grants when purchased.
credits_validity_intervalstringoptionalnullable
ISO 8601 duration string for how long credits remain redeemable. null = credits never expire.
image_idobject-idoptionalnullable
ID of an uploaded Media to use as the course type's hero image.
customers_onlybooleanoptional
When true, only signed-in customers can purchase.
members_onlybooleanoptional
When true, only customers with an active membership of one of the permitted_membership_type_ids can purchase.
permitted_membership_type_idsstring[]optionalnullable
When members_only: true, the list of MembershipType IDs whose holders are eligible to purchase.
category_idsstring[]optional
Category IDs the course type belongs to.
revenue_centrestringoptionalnullable
Free-form revenue centre code for accounting reports.

Responses

200
A single CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/course-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "5-Pack Aromatherapy Massage",
  "currency": "gbp",
  "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase.\n",
  "product_code": "COURSE-AROMA-5",
  "external_id": "ext-aroma-5",
  "offered_online": false,
  "private": false,
  "visibility": "public",
  "offering_type": "area_booking",
  "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "upsell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "cross_sell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "related_retail_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "meta": {
    "title": "string",
    "description": "Free-form text from the resource."
  },
  "quantity": 5,
  "credits_validity_interval": "P1Y",
  "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "customers_only": false,
  "members_only": false,
  "permitted_membership_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "category_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "revenue_centre": "SPA-CREDITS"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "5-Pack Aromatherapy Massage",
    "currency": "gbp",
    "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase.\n",
    "product_code": "COURSE-AROMA-5",
    "external_id": "ext-aroma-5",
    "offered_online": false,
    "private": false,
    "visibility": "public",
    "offering_type": "area_booking",
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "meta": {
      "title": "string",
      "description": "Free-form text from the resource."
    },
    "quantity": 5,
    "credits_validity_interval": "P1Y",
    "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customers_only": false,
    "members_only": false,
    "permitted_membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "revenue_centre": "SPA-CREDITS"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/course-types/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "5-Pack Aromatherapy Massage",
        "currency": "gbp",
        "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase.\n",
        "product_code": "COURSE-AROMA-5",
        "external_id": "ext-aroma-5",
        "offered_online": False,
        "private": False,
        "visibility": "public",
        "offering_type": "area_booking",
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "upsell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "cross_sell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "related_retail_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "meta": {
            "title": "string",
            "description": "Free-form text from the resource."
        },
        "quantity": 5,
        "credits_validity_interval": "P1Y",
        "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "customers_only": False,
        "members_only": False,
        "permitted_membership_type_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "category_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "revenue_centre": "SPA-CREDITS"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/course-types/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => '5-Pack Aromatherapy Massage',
            'currency' => 'gbp',
            'description' => 'Five 60-minute aromatherapy massages, valid for 12 months
from purchase.
',
            'product_code' => 'COURSE-AROMA-5',
            'external_id' => 'ext-aroma-5',
            'offered_online' => false,
            'private' => false,
            'visibility' => 'public',
            'offering_type' => 'area_booking',
            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'upsell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'cross_sell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'related_retail_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'meta' => [
                'title' => 'string',
                'description' => 'Free-form text from the resource.'
            ],
            'quantity' => 5,
            'credits_validity_interval' => 'P1Y',
            'image_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'customers_only' => false,
            'members_only' => false,
            'permitted_membership_type_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'category_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'revenue_centre' => 'SPA-CREDITS'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "5-Pack Aromatherapy Massage",
		"currency": "gbp",
		"description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase.\n",
		"product_code": "COURSE-AROMA-5",
		"external_id": "ext-aroma-5",
		"offered_online": false,
		"private": false,
		"visibility": "public",
		"offering_type": "area_booking",
		"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"upsell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"cross_sell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"related_retail_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"meta": map[string]interface{}{
			"title": "string",
			"description": "Free-form text from the resource.",
		},
		"quantity": 5,
		"credits_validity_interval": "P1Y",
		"image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"customers_only": false,
		"members_only": false,
		"permitted_membership_type_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"category_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"revenue_centre": "SPA-CREDITS",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/course-types/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "availability_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": true,
        "max_duration": 1,
        "min_duration": 1,
        "time_from": "11:00",
        "time_to": "17:00",
        "weekdays": [
          "string"
        ]
      }
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "credits_validity_interval": "P7D",
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "currency": "gbp",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "customers_only": false,
    "description": "Free-form text from the resource.",
    "image": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "members_only": false,
    "meta": {
      "description": "Free-form text from the resource.",
      "title": "string"
    },
    "name": "Alex Morgan",
    "offered_online": false,
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offering_type": "appointment",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "price_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2026-01-15",
        "date_to": "2026-01-15",
        "price": 1
      }
    ],
    "private": false,
    "product_code": "string",
    "quantity": 1,
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "revenue_centre": "string",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "visibility": "public",
    "deleted_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/course-types/{courseTypeId}

Delete a course type

deleteCourseType

Soft-deletes the course type. Existing course credits already sold under this type remain redeemable; the type itself is removed from new-sale flows. Use POST .../restore to bring it back.

Requires the SETTINGS_MANAGE permission on the course type's site. No request body.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Responses

204
Course type deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/course-types/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/course-types/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/course-types/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/course-types/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Course type deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/course-types/{courseTypeId}/availability-rules

List availability rules for a course type

listCourseTypeAvailabilityRules

Returns all AvailabilityRules configured on a CourseType. Rules define when this course type can be purchased — date ranges where it's available or explicitly unavailable.

Rule semantics: any is_available: false rule overrides any is_available: true rule for the same time period (closed beats open).

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Responses

200
A list of AvailabilityRules on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/course-types/abc123/availability-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/availability-rules', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/course-types/abc123/availability-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/course-types/abc123/availability-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/course-types/abc123/availability-rules", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A list of `AvailabilityRule`s on a `CourseType`.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "date_from": "2021-02-15T12:00:00+00:00",
      "date_to": "2021-02-15T12:00:00+00:00",
      "is_available": true,
      "max_duration": 1,
      "min_duration": 1,
      "time_from": "11:00",
      "time_to": "17:00",
      "weekdays": [
        "string"
      ]
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/course-types/{courseTypeId}/availability-rules

Create an availability rule for a course type

createCourseTypeAvailabilityRule

Adds a new AvailabilityRule to a CourseType. Use to open bookable windows (is_available: true) or block existing ones (is_available: false). Course-type availability rules are simpler than appointment- or area-rule equivalents: only date filters, no time-of-day or weekday conditions.

Requires the update permission on the parent course type (typically SETTINGS_MANAGE on the course type's site).

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Request body

is_availablebooleanoptional
Whether the rule opens or closes the window.
date_fromdateoptionalnullable
First date this rule applies.
date_todateoptionalnullable
Last date this rule applies. Must be ≥ date_from.

Responses

201
A single AvailabilityRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/course-types/abc123/availability-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "is_available": true,
  "date_from": "2026-06-01",
  "date_to": "2026-08-31"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/availability-rules', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "is_available": true,
    "date_from": "2026-06-01",
    "date_to": "2026-08-31"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/course-types/abc123/availability-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "is_available": True,
        "date_from": "2026-06-01",
        "date_to": "2026-08-31"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/course-types/abc123/availability-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'is_available' => true,
            'date_from' => '2026-06-01',
            'date_to' => '2026-08-31'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"is_available": true,
		"date_from": "2026-06-01",
		"date_to": "2026-08-31",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/course-types/abc123/availability-rules", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `AvailabilityRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/course-types/{courseTypeId}/availability-rules/{availabilityRuleId}

Retrieve a course-type availability rule

getCourseTypeAvailabilityRule

Returns a single AvailabilityRule belonging to the given CourseType.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Responses

200
A single AvailabilityRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `AvailabilityRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/course-types/{courseTypeId}/availability-rules/{availabilityRuleId}

Update a course-type availability rule

updateCourseTypeAvailabilityRule

Updates an AvailabilityRule. The server validates the same shape as on create, so is_available is required. Requires the update permission on the parent course type.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Request body

is_availablebooleanrequired
Whether the rule opens or closes the window.
date_fromdateoptionalnullable
First date this rule applies.
date_todateoptionalnullable
Last date this rule applies. Must be ≥ date_from.

Responses

200
A single AvailabilityRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "is_available": true,
  "date_from": "2026-06-01",
  "date_to": "2026-08-31"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "is_available": true,
    "date_from": "2026-06-01",
    "date_to": "2026-08-31"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "is_available": True,
        "date_from": "2026-06-01",
        "date_to": "2026-08-31"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'is_available' => true,
            'date_from' => '2026-06-01',
            'date_to' => '2026-08-31'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"is_available": true,
		"date_from": "2026-06-01",
		"date_to": "2026-08-31",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `AvailabilityRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "date_from": "2021-02-15T12:00:00+00:00",
    "date_to": "2021-02-15T12:00:00+00:00",
    "is_available": true,
    "max_duration": 1,
    "min_duration": 1,
    "time_from": "11:00",
    "time_to": "17:00",
    "weekdays": [
      "string"
    ]
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/course-types/{courseTypeId}/availability-rules/{availabilityRuleId}

Delete a course-type availability rule

deleteCourseTypeAvailabilityRule

Removes an AvailabilityRule from a CourseType. Existing bookings/redemptions are unaffected. Future availability is recomputed from whatever rules remain.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
availabilityRuleIdobject-idrequired
The unique identifier of the availability rule.

Responses

204
Availability rule deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/course-types/abc123/availability-rules/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Availability rule deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/course-types/{courseTypeId}/copy

Duplicate a course type

copyCourseType

Creates a copy of an existing CourseType with new fields applied from the request body. name is required so the copy is distinguishable from the source. Fields you omit are inherited from the source.

Requires the SETTINGS_MANAGE permission on the source course type's site.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Request body

namestringrequired
Display name for the new copy. Plain text only — HTML tags are rejected. Required so the copy is distinguishable from the source.
descriptionstringoptionalnullable
Long-form description shown to customers. Markdown rendered.
product_codestringoptionalnullable
External POS/PMS product code.
external_idstringoptionalnullable
External identifier for integrations.
currencystringoptional
The ISO-4217 currency code.
offered_onlinebooleanoptional
Whether bookable via the public shopfront.
privatebooleanoptional
When true, only customers with the direct link can purchase.
visibilitystringoptional
Visibility override. public = everyone; hidden = out of search/browse (still purchasable by direct link); members_only = restricted to permitted membership-type holders.
Possible values:publichiddenmembers_only
offering_typestringoptional
The type of offering the course wraps. Determines which Offering ID the offering_id field references. Note: this field will be removed once the multiple_course_offerings feature flag is fully rolled out.
Possible values:area-bookingappointmentproductsession
offering_idstringoptionalnullable
Identifier of the single underlying offering this course bundles (matched against the type set in offering_type). Note: this field will be removed once the multiple_course_offerings feature flag rolls out — use offerings instead, which supports multiple offerings per course.
offeringsobject[]optional
Multiple offerings bundled by this course. Each entry pairs an offering ID with its type.
upsell_offeringsobject[]optional
cross_sell_offeringsobject[]optional
related_retail_offeringsobject[]optional
quantityintegeroptional
Number of redemptions the course grants the purchaser (e.g. a 10-class card has quantity: 10).
credits_validity_intervalstringoptionalnullable
ISO 8601 duration during which the course credits remain redeemable after purchase. Null = no expiry.
image_idstringoptionalnullable
ID of an uploaded Media for the cover image.
customers_onlybooleanoptional
Restrict purchase to registered customers.
members_onlybooleanoptional
Restrict purchase to permitted membership-type holders.
permitted_membership_type_idsstring[]optionalnullable
Membership-type IDs allowed to purchase when members_only=true.
category_idsstring[]optional
Category IDs for shopfront grouping.
revenue_centrestringoptionalnullable
Revenue centre to post course sales to. Must be valid for the source course type's site.
metaobjectoptional
SEO metadata for the public shopfront page.

Responses

201
The course type was copied.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/course-types/abc123/copy" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Pilates 10-class Course (Evenings)",
  "description": "A 10-class pilates course running on weekday evenings.\nCredits valid for 12 months from purchase.\n",
  "product_code": "PIL-10-EVE",
  "external_id": "ext-course-pil10",
  "currency": "gbp",
  "offered_online": false,
  "private": false,
  "visibility": "public",
  "offering_type": "area-booking",
  "offering_id": "5f1234567890abcdef123456",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "upsell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "cross_sell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "related_retail_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "quantity": 10,
  "credits_validity_interval": "P12M",
  "image_id": "5f1234567890abcdef123456",
  "customers_only": false,
  "members_only": false,
  "permitted_membership_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "category_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "revenue_centre": "course-sales",
  "meta": {
    "title": "string",
    "description": "Free-form text from the resource."
  }
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/copy', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Pilates 10-class Course (Evenings)",
    "description": "A 10-class pilates course running on weekday evenings.\nCredits valid for 12 months from purchase.\n",
    "product_code": "PIL-10-EVE",
    "external_id": "ext-course-pil10",
    "currency": "gbp",
    "offered_online": false,
    "private": false,
    "visibility": "public",
    "offering_type": "area-booking",
    "offering_id": "5f1234567890abcdef123456",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "quantity": 10,
    "credits_validity_interval": "P12M",
    "image_id": "5f1234567890abcdef123456",
    "customers_only": false,
    "members_only": false,
    "permitted_membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "revenue_centre": "course-sales",
    "meta": {
      "title": "string",
      "description": "Free-form text from the resource."
    }
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/course-types/abc123/copy",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Pilates 10-class Course (Evenings)",
        "description": "A 10-class pilates course running on weekday evenings.\nCredits valid for 12 months from purchase.\n",
        "product_code": "PIL-10-EVE",
        "external_id": "ext-course-pil10",
        "currency": "gbp",
        "offered_online": False,
        "private": False,
        "visibility": "public",
        "offering_type": "area-booking",
        "offering_id": "5f1234567890abcdef123456",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "upsell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "cross_sell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "related_retail_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "quantity": 10,
        "credits_validity_interval": "P12M",
        "image_id": "5f1234567890abcdef123456",
        "customers_only": False,
        "members_only": False,
        "permitted_membership_type_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "category_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "revenue_centre": "course-sales",
        "meta": {
            "title": "string",
            "description": "Free-form text from the resource."
        }
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/course-types/abc123/copy', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Pilates 10-class Course (Evenings)',
            'description' => 'A 10-class pilates course running on weekday evenings.
Credits valid for 12 months from purchase.
',
            'product_code' => 'PIL-10-EVE',
            'external_id' => 'ext-course-pil10',
            'currency' => 'gbp',
            'offered_online' => false,
            'private' => false,
            'visibility' => 'public',
            'offering_type' => 'area-booking',
            'offering_id' => '5f1234567890abcdef123456',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'upsell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'cross_sell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'related_retail_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'quantity' => 10,
            'credits_validity_interval' => 'P12M',
            'image_id' => '5f1234567890abcdef123456',
            'customers_only' => false,
            'members_only' => false,
            'permitted_membership_type_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'category_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'revenue_centre' => 'course-sales',
            'meta' => [
                'title' => 'string',
                'description' => 'Free-form text from the resource.'
            ]
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Pilates 10-class Course (Evenings)",
		"description": "A 10-class pilates course running on weekday evenings.\nCredits valid for 12 months from purchase.\n",
		"product_code": "PIL-10-EVE",
		"external_id": "ext-course-pil10",
		"currency": "gbp",
		"offered_online": false,
		"private": false,
		"visibility": "public",
		"offering_type": "area-booking",
		"offering_id": "5f1234567890abcdef123456",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"upsell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"cross_sell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"related_retail_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"quantity": 10,
		"credits_validity_interval": "P12M",
		"image_id": "5f1234567890abcdef123456",
		"customers_only": false,
		"members_only": false,
		"permitted_membership_type_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"category_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"revenue_centre": "course-sales",
		"meta": map[string]interface{}{
			"title": "string",
			"description": "Free-form text from the resource.",
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/course-types/abc123/copy", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The course type was copied.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "availability_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": true,
        "max_duration": 1,
        "min_duration": 1,
        "time_from": "11:00",
        "time_to": "17:00",
        "weekdays": [
          "string"
        ]
      }
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "credits_validity_interval": "P7D",
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "currency": "gbp",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "customers_only": false,
    "description": "Free-form text from the resource.",
    "image": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "members_only": false,
    "meta": {
      "description": "Free-form text from the resource.",
      "title": "string"
    },
    "name": "Alex Morgan",
    "offered_online": false,
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offering_type": "appointment",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "price_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2026-01-15",
        "date_to": "2026-01-15",
        "price": 1
      }
    ],
    "private": false,
    "product_code": "string",
    "quantity": 1,
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "revenue_centre": "string",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "visibility": "public",
    "deleted_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/course-types/{courseTypeId}/price-rules

List price rules for a course type

listCourseTypePriceRules

Returns all PriceRules configured for a CourseType, filterable by date range. Course price rules let you charge different prices for the same course at different times — e.g. summer rates for a membership-credit course. Only date-range filters are supported (no time-of-day or weekday conditions). The first rule whose conditions match the time of sale wins.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Query parameters

date_fromdateoptional
Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.
date_todateoptional
Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page

Responses

200
A list of price rules for a course type.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/course-types/abc123/price-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/price-rules', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/course-types/abc123/price-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/course-types/abc123/price-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/course-types/abc123/price-rules", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A list of price rules for a course type.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "price": 4800,
      "date_from": "2026-01-15",
      "date_to": "2026-01-15",
      "weekdays": [
        "monday"
      ],
      "time_from": "string",
      "time_to": "string",
      "duration": 1
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "total": 3
}

{
  "message": "Unauthenticated"
}

{
  "message": "The requested resource could not be found"
}

post/shop/course-types/{courseTypeId}/price-rules

Create a price rule for a course type

createCourseTypePriceRule

Adds a new PriceRule to a CourseType. Set price and optionally a date_from/date_to window. With no date filters the rule applies always — useful as the baseline price.

Requires the update permission on the parent CourseType (typically SETTINGS_MANAGE on the course type's site).

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Request body

priceintegerrequired
Price in the smallest currency unit (e.g. pence, cents). 12000 is £120.00 on a GBP site.
date_fromdateoptionalnullable
First date this rule applies (inclusive). Defaults to today in the course type's timezone when omitted.
date_todateoptionalnullable
Last date this rule applies (inclusive). Must be on or after date_from if both are set. Null = no end date.

Responses

201
A single PriceRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/course-types/abc123/price-rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "price": 12000,
  "date_from": "2026-06-01",
  "date_to": "2026-08-31"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/price-rules', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "price": 12000,
    "date_from": "2026-06-01",
    "date_to": "2026-08-31"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/course-types/abc123/price-rules",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "price": 12000,
        "date_from": "2026-06-01",
        "date_to": "2026-08-31"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/course-types/abc123/price-rules', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'price' => 12000,
            'date_from' => '2026-06-01',
            'date_to' => '2026-08-31'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"price": 12000,
		"date_from": "2026-06-01",
		"date_to": "2026-08-31",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/course-types/abc123/price-rules", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `PriceRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "price": 4800,
    "date_from": "2026-01-15",
    "date_to": "2026-01-15",
    "weekdays": [
      "monday"
    ],
    "time_from": "string",
    "time_to": "string",
    "duration": 1
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

get/shop/course-types/{courseTypeId}/price-rules/{priceRuleId}

Retrieve a course-type price rule

getCourseTypePriceRule

Returns a single PriceRule belonging to the given CourseType.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
priceRuleIdobject-idrequired
The unique identifier of the price rule.

Responses

200
A single PriceRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `PriceRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "price": 4800,
    "date_from": "2026-01-15",
    "date_to": "2026-01-15",
    "weekdays": [
      "monday"
    ],
    "time_from": "string",
    "time_to": "string",
    "duration": 1
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

put/shop/course-types/{courseTypeId}/price-rules/{priceRuleId}

Update a course-type price rule

updateCourseTypePriceRule

Partially updates a PriceRule on a CourseType. All fields optional. Requires the update permission on the parent course type.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
priceRuleIdobject-idrequired
The unique identifier of the price rule.

Request body

priceintegeroptional
Price in the smallest currency unit.
date_fromdateoptionalnullable
First date this rule applies.
date_todateoptionalnullable
Last date this rule applies. Must be ≥ date_from.

Responses

200
A single PriceRule on a CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found
422
The request didn't pass validation

curl -X PUT "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "price": 12000,
  "date_from": "2026-06-01",
  "date_to": "2026-08-31"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "price": 12000,
    "date_from": "2026-06-01",
    "date_to": "2026-08-31"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.put(
    "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "price": 12000,
        "date_from": "2026-06-01",
        "date_to": "2026-08-31"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'price' => 12000,
            'date_from' => '2026-06-01',
            'date_to' => '2026-08-31'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"price": 12000,
		"date_from": "2026-06-01",
		"date_to": "2026-08-31",
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `PriceRule` on a `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "price": 4800,
    "date_from": "2026-01-15",
    "date_to": "2026-01-15",
    "weekdays": [
      "monday"
    ],
    "time_from": "string",
    "time_to": "string",
    "duration": 1
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}

delete/shop/course-types/{courseTypeId}/price-rules/{priceRuleId}

Delete a course-type price rule

deleteCourseTypePriceRule

Removes a PriceRule from a CourseType. Past purchases priced under this rule are unaffected. Future sales reprice from whatever rules remain (falling back to the course type's base price if none apply).

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.
priceRuleIdobject-idrequired
The unique identifier of the price rule.

Responses

204
Price rule deleted successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X DELETE "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.delete(
    "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.playground.try.be/shop/course-types/abc123/price-rules/abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

Price rule deleted successfully.

// empty response

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

post/shop/course-types/{courseTypeId}/restore

Restore a deleted course type

restoreCourseType

Un-deletes a previously soft-deleted CourseType. The course type returns to its pre-deletion state, including underlying offering associations, quantity, and credit-validity rules. Existing purchases that contained the course remain unaffected.

Requires the SETTINGS_MANAGE permission on the course type's site. No request body.

Path parameters

courseTypeIdobject-idrequired
The ID of a CourseType offering type.

Responses

200
The course type was restored successfully.
401
The user is unauthenticated
403
The authenticated user does not have permission.
404
The resource couldn't be found

curl -X POST "https://api.playground.try.be/shop/course-types/abc123/restore" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types/abc123/restore', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/course-types/abc123/restore",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/course-types/abc123/restore', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/course-types/abc123/restore", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

The course type was restored successfully.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "availability_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": true,
        "max_duration": 1,
        "min_duration": 1,
        "time_from": "11:00",
        "time_to": "17:00",
        "weekdays": [
          "string"
        ]
      }
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "credits_validity_interval": "P7D",
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "currency": "gbp",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "customers_only": false,
    "description": "Free-form text from the resource.",
    "image": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "members_only": false,
    "meta": {
      "description": "Free-form text from the resource.",
      "title": "string"
    },
    "name": "Alex Morgan",
    "offered_online": false,
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offering_type": "appointment",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "price_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2026-01-15",
        "date_to": "2026-01-15",
        "price": 1
      }
    ],
    "private": false,
    "product_code": "string",
    "quantity": 1,
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "revenue_centre": "string",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "visibility": "public",
    "deleted_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "message": "The requested resource could not be found"
}

get/shop/course-types

List course types

listCourseTypes

Returns a paginated list of CourseTypes configured at the given site, ordered by name. Use this to power a settings dashboard or to populate a course-credit selector in the shopfront. The list includes archived items only when archived=true is passed.

Filter by a specific offering with offering_id (matches against the course type's offerings array) or by category with category_id.

Requires the RESERVATIONS_VIEW permission on the site.

Query parameters

site_idstringrequired
Filter results by the site they belong to
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
archivedbooleanoptional
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
offering_idstringoptional
Filter results to course types whose offerings include the given offering ID. Comma-separate to OR multiple IDs (e.g. offering_id=abc,def).
category_idstringoptional
Filter results to course types that include the given category in their category_ids. Comma-separate to OR multiple categories.

Responses

200
A paginated list of CourseTypes for the requested site.
401
The user is unauthenticated
403
The authenticated user does not have permission.

curl "https://api.playground.try.be/shop/course-types?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/course-types?site_id=site_abc123', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
  },
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.get(
    "https://api.playground.try.be/shop/course-types?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.playground.try.be/shop/course-types?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"encoding/json"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.playground.try.be/shop/course-types?site_id=site_abc123", nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A paginated list of `CourseType`s for the requested site.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "availability_rules": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "date_from": "2021-02-15T12:00:00+00:00",
          "date_to": "2021-02-15T12:00:00+00:00",
          "is_available": true,
          "max_duration": 1,
          "min_duration": 1,
          "time_from": "11:00",
          "time_to": "17:00",
          "weekdays": [
            "string"
          ]
        }
      ],
      "category_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "credits_validity_interval": "P7D",
      "cross_sell_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "currency": "gbp",
      "external_id": "00000000-0000-0000-0000-000000000000",
      "customers_only": false,
      "description": "Free-form text from the resource.",
      "image": {
        "id": "00000000-0000-0000-0000-000000000000",
        "file_name": "super-cool-photo.jpg",
        "mime_type": "image/jpeg",
        "original_url": "https://example.com/media/super-cool-photo.jpg",
        "size": 84256,
        "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
      },
      "members_only": false,
      "meta": {
        "description": "Free-form text from the resource.",
        "title": "string"
      },
      "name": "Alex Morgan",
      "offered_online": false,
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_type": "appointment",
      "offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "permitted_membership_type_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "price_rules": [
        {
          "id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "date_from": "2026-01-15",
          "date_to": "2026-01-15",
          "price": 1
        }
      ],
      "private": false,
      "product_code": "string",
      "quantity": 1,
      "related_retail_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "revenue_centre": "string",
      "site_id": "00000000-0000-0000-0000-000000000000",
      "upsell_offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "visibility": "public",
      "deleted_at": "2025-02-04T12:00:00+01:00",
      "updated_at": "2025-02-04T12:00:00+01:00"
    }
  ]
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

post/shop/course-types

Create a course type

createCourseType

Creates a new CourseType at the site referenced via the Trybe-Site-Id header (and the site_id query parameter). The minimum body is name; everything else has a sensible default.

On create the server provisions an internal Coupon to track redemptions of the course type's credits, unless coupon_id is supplied. The new CourseType.coupon_id is set to the resulting coupon's ID.

Requires the SETTINGS_MANAGE permission on the site.

Query parameters

site_idstringrequired
Filter results by the site they belong to
pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
archivedbooleanoptional
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
offering_idstringoptional
Filter results to course types whose offerings include the given offering ID. Comma-separate to OR multiple IDs (e.g. offering_id=abc,def).
category_idstringoptional
Filter results to course types that include the given category in their category_ids. Comma-separate to OR multiple categories.

Request body

namestringrequired
Display name for the course type. Visible to customers in the shopfront and on emailed credit balances. Plain text only.
currencystringoptional
The ISO-4217 currency code.
descriptionstringoptionalnullable
Long-form description shown to customers when they're selecting the course type. Markdown is rendered.
product_codestringoptionalnullable
Optional product code used to map the course type to an external POS or PMS catalog. Free-form; uniqueness is not enforced.
external_idstringoptionalnullable
External identifier used by integrations to reference this offering. Free-form.
offered_onlinebooleanoptional
When true, this course type can be purchased via the public shopfront. When false it is admin-only. Defaults to false.
privatebooleanoptional
When true, the course type is hidden from the public shopfront listing but remains purchasable via direct link. Used for "secret" or staff-only offers.
visibilitystringoptional
The visibility status of the product.
Possible values:publiclink_onlyprivate
coupon_idobject-idoptional
Optional Coupon to use as the redemption-tracking coupon for this course type. When omitted the server creates a new programmatic coupon named " credit" and attaches it.
offering_typestringoptional
Deprecated. The type of offering this course unlocks. Used together with offering_id for legacy single- offering course types. New callers should populate offerings instead.
Possible values:area_bookingappointmentproductsession
offering_idobject-idoptionalnullable
Deprecated. The ID of the single offering this course unlocks. Paired with offering_type. New callers should populate offerings instead.
offeringsobject[]optional
List of offerings this course type unlocks. Each entry identifies one offering by type + ID. Offerings must belong to the same site as the course type — others are dropped at validation time.
quantityintegeroptional
Number of credits the course grants when purchased. Defaults to 1.
credits_validity_intervalstringoptionalnullable
ISO 8601 duration string for how long credits remain redeemable from purchase. null means credits never expire. Example: P1Y = 1 year, P6M = 6 months.
image_idobject-idoptionalnullable
ID of an uploaded Media to use as the course type's hero image.
customers_onlybooleanoptional
When true, only signed-in customers can purchase. When false, guest checkout is allowed.
members_onlybooleanoptional
When true, only customers with an active membership of one of the permitted_membership_type_ids can purchase.
upsell_offeringsobject[]optional
Offerings shown as upsells during checkout.
cross_sell_offeringsobject[]optional
Offerings shown as cross-sells on the course type's detail page.
related_retail_offeringsobject[]optional
Retail products shown as related items.
permitted_membership_type_idsstring[]optionalnullable
When members_only: true, the list of MembershipType IDs whose holders are eligible to purchase. Must belong to the same brand as the course type's site.
category_idsstring[]optional
Category IDs the course type belongs to. Used for shopfront grouping.
revenue_centrestringoptionalnullable
Free-form revenue centre code for accounting reports. Must be a configured revenue centre on the course type's site.

Responses

201
A single CourseType.
401
The user is unauthenticated
403
The authenticated user does not have permission.
422
The request didn't pass validation

curl -X POST "https://api.playground.try.be/shop/course-types?site_id=site_abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "5-Pack Aromatherapy Massage",
  "currency": "gbp",
  "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase. Use them whenever — no booking deadline.\n",
  "product_code": "COURSE-AROMA-5",
  "external_id": "ext-aroma-5",
  "offered_online": false,
  "private": false,
  "visibility": "public",
  "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "offering_type": "area_booking",
  "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "quantity": 5,
  "credits_validity_interval": "P1Y",
  "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
  "customers_only": false,
  "members_only": false,
  "upsell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "cross_sell_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "related_retail_offerings": [
    {
      "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "offering_name": "Twilight massage",
      "offering_type": "appointment"
    }
  ],
  "permitted_membership_type_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "category_ids": [
    "64a9f3b2c3d8e1f4a5b6c7d8"
  ],
  "revenue_centre": "courses"
}'

const response = await fetch('https://api.playground.try.be/shop/course-types?site_id=site_abc123', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "5-Pack Aromatherapy Massage",
    "currency": "gbp",
    "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase. Use them whenever — no booking deadline.\n",
    "product_code": "COURSE-AROMA-5",
    "external_id": "ext-aroma-5",
    "offered_online": false,
    "private": false,
    "visibility": "public",
    "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offering_type": "area_booking",
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "quantity": 5,
    "credits_validity_interval": "P1Y",
    "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "customers_only": false,
    "members_only": false,
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "revenue_centre": "courses"
  }),
})

if (!response.ok) {
  throw new Error(`Trybe API ${response.status}: ${await response.text()}`)
}

const data = await response.json()

import httpx

response = httpx.post(
    "https://api.playground.try.be/shop/course-types?site_id=site_abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "5-Pack Aromatherapy Massage",
        "currency": "gbp",
        "description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase. Use them whenever — no booking deadline.\n",
        "product_code": "COURSE-AROMA-5",
        "external_id": "ext-aroma-5",
        "offered_online": False,
        "private": False,
        "visibility": "public",
        "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_type": "area_booking",
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "quantity": 5,
        "credits_validity_interval": "P1Y",
        "image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "customers_only": False,
        "members_only": False,
        "upsell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "cross_sell_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "related_retail_offerings": [
            {
                "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                "offering_name": "Twilight massage",
                "offering_type": "appointment"
            }
        ],
        "permitted_membership_type_ids": [
            "00000000-0000-0000-0000-000000000000"
        ],
        "category_ids": [
            "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "revenue_centre": "courses"
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/course-types?site_id=site_abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => '5-Pack Aromatherapy Massage',
            'currency' => 'gbp',
            'description' => 'Five 60-minute aromatherapy massages, valid for 12 months
from purchase. Use them whenever — no booking deadline.
',
            'product_code' => 'COURSE-AROMA-5',
            'external_id' => 'ext-aroma-5',
            'offered_online' => false,
            'private' => false,
            'visibility' => 'public',
            'coupon_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'offering_type' => 'area_booking',
            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'quantity' => 5,
            'credits_validity_interval' => 'P1Y',
            'image_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
            'customers_only' => false,
            'members_only' => false,
            'upsell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'cross_sell_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'related_retail_offerings' => [
                [
                    'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                    'offering_name' => 'Twilight massage',
                    'offering_type' => 'appointment'
                ]
            ],
            'permitted_membership_type_ids' => [
                '00000000-0000-0000-0000-000000000000'
            ],
            'category_ids' => [
                '64a9f3b2c3d8e1f4a5b6c7d8'
            ],
            'revenue_centre' => 'courses'
        ],
]);

$data = json_decode($response->getBody(), true);

package main

import (
	"bytes"
	"encoding/json"
	"net/http"
)

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "5-Pack Aromatherapy Massage",
		"currency": "gbp",
		"description": "Five 60-minute aromatherapy massages, valid for 12 months\nfrom purchase. Use them whenever — no booking deadline.\n",
		"product_code": "COURSE-AROMA-5",
		"external_id": "ext-aroma-5",
		"offered_online": false,
		"private": false,
		"visibility": "public",
		"coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"offering_type": "area_booking",
		"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"quantity": 5,
		"credits_validity_interval": "P1Y",
		"image_id": "64a9f3b2c3d8e1f4a5b6c7d8",
		"customers_only": false,
		"members_only": false,
		"upsell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"cross_sell_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"related_retail_offerings": []interface{}{
			map[string]interface{}{
				"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
				"offering_name": "Twilight massage",
				"offering_type": "appointment",
			},
		},
		"permitted_membership_type_ids": []interface{}{
			"00000000-0000-0000-0000-000000000000",
		},
		"category_ids": []interface{}{
			"64a9f3b2c3d8e1f4a5b6c7d8",
		},
		"revenue_centre": "courses",
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/course-types?site_id=site_abc123", bytes.NewBuffer(payload))
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
}

A single `CourseType`.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "availability_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2021-02-15T12:00:00+00:00",
        "date_to": "2021-02-15T12:00:00+00:00",
        "is_available": true,
        "max_duration": 1,
        "min_duration": 1,
        "time_from": "11:00",
        "time_to": "17:00",
        "weekdays": [
          "string"
        ]
      }
    ],
    "category_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "coupon_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "credits_validity_interval": "P7D",
    "cross_sell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "currency": "gbp",
    "external_id": "00000000-0000-0000-0000-000000000000",
    "customers_only": false,
    "description": "Free-form text from the resource.",
    "image": {
      "id": "00000000-0000-0000-0000-000000000000",
      "file_name": "super-cool-photo.jpg",
      "mime_type": "image/jpeg",
      "original_url": "https://example.com/media/super-cool-photo.jpg",
      "size": 84256,
      "url": "https://example.com/media/super-cool-photo-thumbnail@2x.jpg"
    },
    "members_only": false,
    "meta": {
      "description": "Free-form text from the resource.",
      "title": "string"
    },
    "name": "Alex Morgan",
    "offered_online": false,
    "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "offering_type": "appointment",
    "offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "64a9f3b2c3d8e1f4a5b6c7d8"
    ],
    "price_rules": [
      {
        "id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "date_from": "2026-01-15",
        "date_to": "2026-01-15",
        "price": 1
      }
    ],
    "private": false,
    "product_code": "string",
    "quantity": 1,
    "related_retail_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "revenue_centre": "string",
    "site_id": "00000000-0000-0000-0000-000000000000",
    "upsell_offerings": [
      {
        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "visibility": "public",
    "deleted_at": "2025-02-04T12:00:00+01:00",
    "updated_at": "2025-02-04T12:00:00+01:00"
  }
}

{
  "message": "Unauthenticated"
}

{
  "message": "This action is unauthorized."
}

{
  "errors": {},
  "message": "The request didn't pass validation"
}