Apply Coupon

Overview

Applies a coupon code to a payment status, reducing the amount due. The payment status must reference a coupon-eligible entity type: Meeting, EventAttendance, PendingBooking, or Cart. Payment statuses for other entity types (e.g., Invoice, ClientBookingPackage, ProductOrder) will return 422 "Invalid Coupon" even if the coupon code itself is valid.

Available for Staff, App, and Directory tokens.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

payment status id

Query Params
string
required

Coupon code

Responses

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