Skip to main content
GET
Get Member Issued Discounts

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

member_id
string
required

Response

Successful Response

type
enum<string>
required

Type of discount (CATEGORY, PRODUCT, SERVICE, ALL)

Available options:
GLOBAL,
CUSTOM,
MEMBERSHIP,
PACKAGE,
SAVED_ITEM,
PROMOTION
id
string

Unique identifier for the discount

discountTemplateId
string | null

ID of the template this discount was created from

patientId
string | null

ID of the patient who owns this discount

memberId
string | null

ID of the member this discount belongs to

soldPackageId
string | null

ID of the sold package that created this discount

createdByChargeItemId
string | null

ID of the charge item that created this discount (for saved items)

discountChoiceId
string | null

ID of the discount choice group

itemId
string | null

ID of the specific item for this discount

category
string | null

Category name this discount applies to

itemType
enum<string> | null

Type of item this discount applies to

Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD
percentage
number | null

Discount percentage (0-100)

Required range: 0 <= x <= 100
amount
integer | null

Discount amount in cents

Required range: x >= 0
quantity
integer | null

Total quantity for this discount (None = infinite)

quantityRemaining
integer | null

Quantity remaining in the discount

expiryDate
string<date-time> | null

When this discount expires

uses
DiscountUse · object[]

Usages of this discount

isStackable
boolean
default:true

Whether this discount can be combined with other discounts

isPrepayment
boolean
default:false

Whether this is a prepayment (commissions on full price)

isChosen
boolean | null

Whether this discount was chosen from a choice group

isArchived
boolean
default:false

Whether the discount is archived

comment
string | null

Optional comment for custom discounts

group
string | null

Group for choice-based discounts

member
MemberTiny · object | null

Member this discount belongs to

soldPackage
DiscountSoldPackageTiny · object | null

Sold package this discount belongs to

item
DiscountItemTiny · object | null

Item this discount applies to

discountTemplate
DiscountTemplateTiny · object | null

Discount template this discount was created from

isRedeemable
boolean
default:false

Whether the discount can currently be redeemed in checkout/cart flows