Calendar & Scheduling

Commission Packages

A CommissionPackage defines the commission rates a practitioner earns. Each package can have multiple rates with individual thresholds, date ranges, and evaluation periods.

get/shop/commission-packages

List CommissionPackages

listCommissionPackages

Use this endpoint to retrieve a list of CommissionPackages for a site.

Query parameters

pageintegeroptional
The page to retrieve results from
per_pageintegeroptional
The number of results to return per page
site_idstringoptional
Filter results by the site they belong to

Responses

200
The CommissionPackages were successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/commission-packages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/commission-packages', {
  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/commission-packages",
    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/commission-packages', [
    '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/commission-packages", 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 `CommissionPackage`s were successfully retrieved.

{
  "data": [
    {
      "id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "name": "Senior Therapist Package",
      "default_evaluation_period": null,
      "requested_surcharge_percentage": 5,
      "rates": [
        {
          "name": "Standard rate",
          "percentage": 10,
          "calculation_basis": "before_discount",
          "offerings": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "offering_sets": [
            {
              "id": "00000000-0000-0000-0000-000000000000"
            }
          ],
          "threshold_amount": 100000,
          "evaluation_period": null,
          "valid_from": "2026-01-15",
          "valid_to": "2026-01-15"
        }
      ],
      "site_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "organisation_id": "64a9f3b2c3d8e1f4a5b6c7d8",
      "created_at": "2026-01-15T09:30:00+00:00",
      "updated_at": "2026-01-15T09:30:00+00:00"
    }
  ],
  "meta": {
    "from": 1,
    "to": 2,
    "total": 2,
    "current_page": 1,
    "last_page": 2,
    "per_page": 15,
    "path": "http://example.com/api"
  },
  "links": {
    "first": "http://example.com?page=1",
    "next": "https://example.com?page=3",
    "prev": "https://example.com?page=1",
    "last": "https://example.com?page=4"
  }
}

{
  "message": "Unauthenticated"
}

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

post/shop/commission-packages

Create CommissionPackage

createCommissionPackage

Use this endpoint to create a new CommissionPackage for a site.

Query parameters

site_idstringoptional
Filter results by the site they belong to

Request body

namestringoptional
Display name of the commission package, shown in the admin UI when assigning packages to practitioners and on commission reports. Pick a name that summarises the package's rate structure. 1-120 characters.
default_evaluation_periodoptional
The default period over which commission earned under this package is aggregated and paid out. Determines whether targets and tiers reset weekly, monthly, etc. Accepts the EvaluationPeriod enum values.
requested_surcharge_percentagenumberoptionalnullable
An optional surcharge percentage applied to requested practitioner bookings.
ratesobject[]optional
The commission rates for this package.

Responses

201
The CommissionPackage was successfully retrieved.
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/commission-packages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Senior Therapist Package",
  "requested_surcharge_percentage": 5,
  "rates": [
    {
      "name": "Standard rate",
      "percentage": 10,
      "calculation_basis": "before_discount",
      "offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "offering_set_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "threshold_amount": 100000,
      "valid_from": "2026-01-15",
      "valid_to": "2026-01-15"
    }
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/commission-packages', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Senior Therapist Package",
    "requested_surcharge_percentage": 5,
    "rates": [
      {
        "name": "Standard rate",
        "percentage": 10,
        "calculation_basis": "before_discount",
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ],
        "offering_set_ids": [
          "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "threshold_amount": 100000,
        "valid_from": "2026-01-15",
        "valid_to": "2026-01-15"
      }
    ]
  }),
})

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/commission-packages",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Senior Therapist Package",
        "requested_surcharge_percentage": 5,
        "rates": [
            {
                "name": "Standard rate",
                "percentage": 10,
                "calculation_basis": "before_discount",
                "offerings": [
                    {
                        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                        "offering_name": "Twilight massage",
                        "offering_type": "appointment"
                    }
                ],
                "offering_set_ids": [
                    "64a9f3b2c3d8e1f4a5b6c7d8"
                ],
                "threshold_amount": 100000,
                "valid_from": "2026-01-15",
                "valid_to": "2026-01-15"
            }
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.playground.try.be/shop/commission-packages', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Senior Therapist Package',
            'requested_surcharge_percentage' => 5,
            'rates' => [
                [
                    'name' => 'Standard rate',
                    'percentage' => 10,
                    'calculation_basis' => 'before_discount',
                    'offerings' => [
                        [
                            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                            'offering_name' => 'Twilight massage',
                            'offering_type' => 'appointment'
                        ]
                    ],
                    'offering_set_ids' => [
                        '64a9f3b2c3d8e1f4a5b6c7d8'
                    ],
                    'threshold_amount' => 100000,
                    'valid_from' => '2026-01-15',
                    'valid_to' => '2026-01-15'
                ]
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Senior Therapist Package",
		"requested_surcharge_percentage": 5,
		"rates": []interface{}{
			map[string]interface{}{
				"name": "Standard rate",
				"percentage": 10,
				"calculation_basis": "before_discount",
				"offerings": []interface{}{
					map[string]interface{}{
						"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
						"offering_name": "Twilight massage",
						"offering_type": "appointment",
					},
				},
				"offering_set_ids": []interface{}{
					"64a9f3b2c3d8e1f4a5b6c7d8",
				},
				"threshold_amount": 100000,
				"valid_from": "2026-01-15",
				"valid_to": "2026-01-15",
			},
		},
	})
	req, _ := http.NewRequest("POST", "https://api.playground.try.be/shop/commission-packages", 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 `CommissionPackage` was successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Senior Therapist Package",
    "default_evaluation_period": null,
    "requested_surcharge_percentage": 5,
    "rates": [
      {
        "name": "Standard rate",
        "percentage": 10,
        "calculation_basis": "before_discount",
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ],
        "offering_sets": [
          {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "name": "Alex Morgan"
          }
        ],
        "threshold_amount": 100000,
        "evaluation_period": null,
        "valid_from": "2026-01-15",
        "valid_to": "2026-01-15"
      }
    ],
    "site_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "organisation_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00: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/commission-packages/{commissionPackageId}

Show CommissionPackage

getCommissionPackage

Use this endpoint to retrieve a single CommissionPackage.

Path parameters

commissionPackageIdmongo-idrequired
The ID of the commission package.

Query parameters

site_idstringoptional
Filter results by the site they belong to

Responses

200
The CommissionPackage was successfully retrieved.
401
The user is unauthenticated
404
The resource couldn't be found

curl "https://api.playground.try.be/shop/commission-packages/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/commission-packages/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/commission-packages/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/commission-packages/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/commission-packages/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)
}

The `CommissionPackage` was successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Senior Therapist Package",
    "default_evaluation_period": null,
    "requested_surcharge_percentage": 5,
    "rates": [
      {
        "name": "Standard rate",
        "percentage": 10,
        "calculation_basis": "before_discount",
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ],
        "offering_sets": [
          {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "name": "Alex Morgan"
          }
        ],
        "threshold_amount": 100000,
        "evaluation_period": null,
        "valid_from": "2026-01-15",
        "valid_to": "2026-01-15"
      }
    ],
    "site_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "organisation_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00:00"
  }
}

{
  "message": "Unauthenticated"
}

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

put/shop/commission-packages/{commissionPackageId}

Update CommissionPackage

updateCommissionPackage

Use this endpoint to update a CommissionPackage.

Path parameters

commissionPackageIdmongo-idrequired
The ID of the commission package.

Query parameters

site_idstringoptional
Filter results by the site they belong to

Request body

namestringoptional
Display name of the commission package, shown in the admin UI when assigning packages to practitioners and on commission reports. Pick a name that summarises the package's rate structure. 1-120 characters.
default_evaluation_periodoptional
The default period over which commission earned under this package is aggregated and paid out. Determines whether targets and tiers reset weekly, monthly, etc. Accepts the EvaluationPeriod enum values.
requested_surcharge_percentagenumberoptionalnullable
An optional surcharge percentage applied to requested practitioner bookings.
ratesobject[]optional
The commission rates for this package.

Responses

200
The CommissionPackage was successfully retrieved.
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/commission-packages/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Senior Therapist Package",
  "requested_surcharge_percentage": 5,
  "rates": [
    {
      "name": "Standard rate",
      "percentage": 10,
      "calculation_basis": "before_discount",
      "offerings": [
        {
          "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
          "offering_name": "Twilight massage",
          "offering_type": "appointment"
        }
      ],
      "offering_set_ids": [
        "64a9f3b2c3d8e1f4a5b6c7d8"
      ],
      "threshold_amount": 100000,
      "valid_from": "2026-01-15",
      "valid_to": "2026-01-15"
    }
  ]
}'

const response = await fetch('https://api.playground.try.be/shop/commission-packages/abc123', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
    Accept: 'application/json',
  },
  body: JSON.stringify({
    "name": "Senior Therapist Package",
    "requested_surcharge_percentage": 5,
    "rates": [
      {
        "name": "Standard rate",
        "percentage": 10,
        "calculation_basis": "before_discount",
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ],
        "offering_set_ids": [
          "64a9f3b2c3d8e1f4a5b6c7d8"
        ],
        "threshold_amount": 100000,
        "valid_from": "2026-01-15",
        "valid_to": "2026-01-15"
      }
    ]
  }),
})

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/commission-packages/abc123",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
        "Content-Type": "application/json",
    },
    json={
        "name": "Senior Therapist Package",
        "requested_surcharge_percentage": 5,
        "rates": [
            {
                "name": "Standard rate",
                "percentage": 10,
                "calculation_basis": "before_discount",
                "offerings": [
                    {
                        "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
                        "offering_name": "Twilight massage",
                        "offering_type": "appointment"
                    }
                ],
                "offering_set_ids": [
                    "64a9f3b2c3d8e1f4a5b6c7d8"
                ],
                "threshold_amount": 100000,
                "valid_from": "2026-01-15",
                "valid_to": "2026-01-15"
            }
        ]
    },
)
response.raise_for_status()
data = response.json()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://api.playground.try.be/shop/commission-packages/abc123', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
        'Content-Type' => 'application/json',
    ],
    'json' => [
            'name' => 'Senior Therapist Package',
            'requested_surcharge_percentage' => 5,
            'rates' => [
                [
                    'name' => 'Standard rate',
                    'percentage' => 10,
                    'calculation_basis' => 'before_discount',
                    'offerings' => [
                        [
                            'offering_id' => '64a9f3b2c3d8e1f4a5b6c7d8',
                            'offering_name' => 'Twilight massage',
                            'offering_type' => 'appointment'
                        ]
                    ],
                    'offering_set_ids' => [
                        '64a9f3b2c3d8e1f4a5b6c7d8'
                    ],
                    'threshold_amount' => 100000,
                    'valid_from' => '2026-01-15',
                    'valid_to' => '2026-01-15'
                ]
            ]
        ],
]);

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

package main

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

func main() {
	payload, _ := json.Marshal(map[string]interface{}{
		"name": "Senior Therapist Package",
		"requested_surcharge_percentage": 5,
		"rates": []interface{}{
			map[string]interface{}{
				"name": "Standard rate",
				"percentage": 10,
				"calculation_basis": "before_discount",
				"offerings": []interface{}{
					map[string]interface{}{
						"offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
						"offering_name": "Twilight massage",
						"offering_type": "appointment",
					},
				},
				"offering_set_ids": []interface{}{
					"64a9f3b2c3d8e1f4a5b6c7d8",
				},
				"threshold_amount": 100000,
				"valid_from": "2026-01-15",
				"valid_to": "2026-01-15",
			},
		},
	})
	req, _ := http.NewRequest("PUT", "https://api.playground.try.be/shop/commission-packages/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)
}

The `CommissionPackage` was successfully retrieved.

{
  "data": {
    "id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "name": "Senior Therapist Package",
    "default_evaluation_period": null,
    "requested_surcharge_percentage": 5,
    "rates": [
      {
        "name": "Standard rate",
        "percentage": 10,
        "calculation_basis": "before_discount",
        "offerings": [
          {
            "offering_id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "offering_name": "Twilight massage",
            "offering_type": "appointment"
          }
        ],
        "offering_sets": [
          {
            "id": "64a9f3b2c3d8e1f4a5b6c7d8",
            "name": "Alex Morgan"
          }
        ],
        "threshold_amount": 100000,
        "evaluation_period": null,
        "valid_from": "2026-01-15",
        "valid_to": "2026-01-15"
      }
    ],
    "site_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "organisation_id": "64a9f3b2c3d8e1f4a5b6c7d8",
    "created_at": "2026-01-15T09:30:00+00:00",
    "updated_at": "2026-01-15T09:30:00+00: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/commission-packages/{commissionPackageId}

Delete CommissionPackage

deleteCommissionPackage

Use this endpoint to delete a CommissionPackage.

Path parameters

commissionPackageIdmongo-idrequired
The ID of the commission package.

Query parameters

site_idstringoptional
Filter results by the site they belong to

Responses

204
The CommissionPackage was successfully deleted.
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/commission-packages/abc123" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

const response = await fetch('https://api.playground.try.be/shop/commission-packages/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/commission-packages/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/commission-packages/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/commission-packages/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)
}

The `CommissionPackage` was successfully deleted.

// empty response

{
  "message": "Unauthenticated"
}

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

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