API Reference

Get Valid Coupons for Entity

get deprecated
https://api.vcita.biz/v2/coupons/valid_coupons

Overview

DEPRECATED - Use the v3 alternative GET /v3/sales/coupons instead.

Retrieves a list of valid (redeemable) coupons for a specific entity. Available for Staff tokens.

This endpoint returns only coupons that are currently active, not expired, and eligible for the specified entity based on service and staff restrictions.

Query Params
string
required

The UID of the entity to check coupon validity against (e.g., a payment UID, appointment UID, or event attendance UID).

string
required

The type of entity. Possible values: payment, appointment, event_attendance.

Responses

Updated 2 months ago

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