Skip to main content
GET
List Sold Packages

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

patient_id
string | null

Filter by patient ID

package_id
string | null

Filter by package ID

patient_name
string | null

Filter by patient name

last_activity_date
(string | null)[] | null

Filter by last activity date range

purchased_date
(string | null)[] | null

Filter by purchased date range

status
string[] | null

Filter by package status

location_ids
string[] | null

Filter by purchase location IDs

timezone
string
default:UTC

Clinic timezone for date range bounds

sort_by
string | null
default:created_date

Sort field

sort_direction
string | null
default:desc

Sort direction (asc or desc)

Response

Successful Response

packageId
string
required

Package ID that was sold

patientId
string
required

Patient ID who purchased the package

chargeItemId
string
required

Charge item ID associated with the package purchase

status
enum<string>
required

Status of the sold package

Available options:
USED,
ACTIVE,
CANCELLED
package
PackageDetail · object
required

Details of the package

createdDate
string<date-time>
required

Date the package was created

patient
PatientSummary · object
required

Details of the patient

chargeItem
ChargeItemTiny · object
required

Simplified details of the charge item

id
string

Unique identifier for the sold package

cancellationReason
string | null

Reason for cancellation if the package is cancelled

expiresAt
string<date-time> | null

When this sold copy expires. Stamped at purchase for PURCHASE-anchored packages and on the first redemption for FIRST_REDEMPTION-anchored ones. Null means it has no expiry yet.

updatedDate
string<date-time> | null

Date the package was updated

lastActivityDate
string<date-time> | null

Most recent package usage date

discounts
DiscountDetailWithSource · object[]

Discounts applied to the sold package