Sign in
CommissionPackages

Update CommissionPackage

Use this endpoint to update a CommissionPackage.

put/shop/commission-packages/{commissionPackageId}

Request body

namestring

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_period'weekly' | 'bi_weekly' | 'monthly'
week_starts_on'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' nullable

A day of the week.

requested_surcharge_percentagenumber nullable

An optional surcharge percentage applied to requested practitioner bookings.

Example request

{
  "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
    }
  ]
}

Response

The CommissionPackage was 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
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.