Skip to main content
POST
Transfer Discount

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

source_discount_id
string
required

Body

application/json

Input schema for POST /billing/discount/{source_discount_id}/transfer.

toPatientId
string
required

Patient who should receive the transferred uses

quantity
integer
required

How many redemptions to move (must be > 0)

reason
enum<string>
required

Why the transfer is being made

Available options:
GIFT,
FAMILY_SHARE,
ACCOUNT_MERGE,
CORRECTION,
OTHER
note
string | null

Optional internal note explaining the transfer

Maximum string length: 1000

Response

Successful Response

Serialized discount-transfer audit row.

id
string
required

Unique identifier for the transfer

sourceDiscountId
string
required

Discount the redemptions were taken from

destinationDiscountId
string
required

Newly-created discount the redemptions landed on

fromPatientId
string
required

Patient the source discount belonged to

toPatientId
string
required

Patient who received the new discount

quantity
integer
required

How many redemptions were moved

reason
enum<string>
required

Why the transfer was made

Available options:
GIFT,
FAMILY_SHARE,
ACCOUNT_MERGE,
CORRECTION,
OTHER
creatorId
string
required

User who recorded the transfer

createdDate
string<date-time>
required

When the transfer was recorded

discountName
string | null

Display label for the transferred discount (item, category, or item-type bucket)

discountValue
string | null

Formatted value of the transferred discount (e.g. '10%' or '$50')

fromPatientName
string | null

Display name of the sending patient

toPatientName
string | null

Display name of the receiving patient

note
string | null

Optional internal note from the staff member

creatorName
string | null

Display name of the user who recorded the transfer