Sign in
CommissionPackages

List CommissionPackages

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

get/shop/commission-packages

Query parameters

pageinteger

The page to retrieve results from

per_pageinteger

The number of results to return per page

Response

The CommissionPackages were successfully retrieved.

Example response

{
  "data": [
    {
      "name": "Senior Therapist Package",
      "week_starts_on": "monday",
      "requested_surcharge_percentage": 5,
      "rates": [
        {
          "name": "Standard rate",
          "rate_type": "percentage",
          "percentage": 10,
          "flat_amount": 500,
          "attribution": "performed",
          "offerings": [
            {
              "offering_name": "Twilight massage",
              "offering_type": "appointment"
            }
          ],
          "threshold_amount": 100000
        }
      ]
    }
  ],
  "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"
  }
}

Changes