---
title: "List CommissionPackages"
method: GET
path: "/shop/commission-packages"
tags: ["CommissionPackages"]
---

# List CommissionPackages

`GET /shop/commission-packages`

Use this endpoint to retrieve a list of `CommissionPackage`s for a site.

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

The `CommissionPackage`s were successfully retrieved.

- object
  - `data` CommissionPackage[], required
    - `id` string, mongo-id, required — The ID of the commission package.
    - `name` string, required — The name of the commission package.
    - `default_evaluation_period` 'weekly' | 'bi_weekly' | 'monthly', required — The default period over which commission is evaluated.
    - `week_starts_on` 'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday', nullable, required — The day a `weekly` or `bi_weekly` evaluation period starts on. Defaults to `monday` when not set.
    - `requested_surcharge_percentage` number, nullable, required — An optional surcharge percentage applied to requested practitioner bookings.
    - `rates` CommissionRate[], required — The commission rates defined in this package.
      - `name` string, nullable, required — The name of the rate.
      - `rate_type` 'percentage' | 'flat', nullable, required — Whether this rate pays a `percentage` of the item's value or a `flat_amount` per item. Defaults to `percentage` when not set, including for rates persisted before flat rates were introduced.
      - `percentage` number, nullable, required — The commission percentage to apply. Populated only when `rate_type` is `percentage`; `null` for a `flat` rate.
      - `flat_amount` integer, nullable, required — The fixed commission amount to pay per item, in pence. Populated only when `rate_type` is `flat`; `null` for a `percentage` rate.
      - `calculation_basis` 'before_discount' | 'after_discount', required — Whether the commission is calculated on the price before or after discount.
      - `attribution` 'performed' | 'sold', nullable, required — Which side of the sale this rate rewards. Defaults to `performed` (the practitioner who delivered the service) when not set; `sold` rewards the basket item's `sold_by` attribution instead.
      - `offerings` OfferingIdentifier[], required — The specific offerings this rate applies to. An empty array means the rate applies to all offerings.
        - `offering_id` string, mongo-id, required — The ID of the offering.
        - `offering_name` string, required — The name of the offering.
        - `offering_type` 'appointment' | 'appointment_enquiry' | 'area_booking' | 'course' | 'hotel_room_reservation' | 'membership' | 'package' | 'product' | 'session' | 'table_reservation' | 'voucher', required — Discriminator describing what kind of sellable item an `Offering` represents. The value determines which downstream schema (`Appointment`, `Session`, `Package`, etc.) the offering's `offering_id` resolves against, and which checkout/booking flow applies.
      - `offering_sets` OfferingSetSummary[], required — The offering sets this rate applies to.
        - `id` string, mongo-id, required — The ID of the offering set.
        - `name` string, required — The name of the offering set.
      - `threshold_amount` integer, nullable, required — The minimum revenue threshold (in pence) that must be reached before this rate applies.
      - `evaluation_period` 'weekly' | 'bi_weekly' | 'monthly', nullable, required — Overrides the package's default evaluation period for this rate.
      - `valid_from` string, date, nullable, required — The date from which this rate is valid.
      - `valid_to` string, date, nullable, required — The date until which this rate is valid.
    - `site_id` string, mongo-id, required — The ID of the site this package belongs to.
    - `organisation_id` string, mongo-id, required — The ID of the organisation this package belongs to.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set

## Other responses

- `401` — The user is unauthenticated
- `404` — The resource couldn't be found

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)