Apply Coupon to Entity

Overview

Applies a coupon to a specific entity (payment, appointment, or event attendance), granting the associated discount. Available for Staff tokens.

Validation

  • The coupon must be active (not expired or disabled).
  • The coupon must not have exceeded its max_redemptions or max_redemptions_per_client limits.
  • If the coupon has valid_services or valid_staff restrictions, the entity must match those restrictions.
Path Params
string
required

The unique identifier of the coupon to apply.

Body Params
string
required

The type of entity to apply the coupon to. Possible values: payment, appointment, event_attendance.

string
required

The UID of the entity to apply the coupon to.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json