Get Patient Discounts
Get the redeemable discounts for a patient.
This includes discounts from:
- Memberships (gated on the shared rule: blocked only for FROZEN members, otherwise governed by the discount’s own expiry/quantity)
- Purchased packages
- Promotions
Note: Custom discounts created during checkout are excluded from this endpoint.
Args: patient_id: The patient’s ID include_expired: Whether to include expired discounts (default: False)
Returns: List of active discounts available to the patient
Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Query Parameters
ITEM, SERVICE, PRODUCT, PACKAGE, MEMBERSHIP, MEDICATION, SERVICE_FEE, GIFT_CARD GLOBAL, CUSTOM, MEMBERSHIP, PACKAGE, SAVED_ITEM, PROMOTION Response
Successful Response
Type of discount (CATEGORY, PRODUCT, SERVICE, ALL)
GLOBAL, CUSTOM, MEMBERSHIP, PACKAGE, SAVED_ITEM, PROMOTION Unique identifier for the discount
ID of the template this discount was created from
ID of the patient who owns this discount
ID of the member this discount belongs to
ID of the sold package that created this discount
ID of the charge item that created this discount (for saved items)
ID of the discount choice group
ID of the specific item for this discount
Category name this discount applies to
Type of item this discount applies to
ITEM, SERVICE, PRODUCT, PACKAGE, MEMBERSHIP, MEDICATION, SERVICE_FEE, GIFT_CARD Discount percentage (0-100)
0 <= x <= 100Discount amount in cents
x >= 0Total quantity for this discount (None = infinite)
Quantity remaining in the discount
When this discount expires
Usages of this discount
Whether this discount can be combined with other discounts
Whether this is a prepayment (commissions on full price)
Whether this discount was chosen from a choice group
Whether the discount is archived
Optional comment for custom discounts
Group for choice-based discounts
Member this discount belongs to
Sold package this discount belongs to
Item this discount applies to
Discount template this discount was created from
