Sign in
provider
inventory

Get Package Usage

Get the usage of a package with optional filtering and sorting.

get/inventory/packages/usage/{package_id}

Path parameters

package_idstring required

Query parameters

patient_namestring nullable

Filter by patient name

Filter by patient name

last_activity_datestring nullable

Filter by last activity date

Filter by last activity date

purchased_datestring nullable

Filter by purchased date

Filter by purchased date

statusstring[] nullable

Filter by package status

Filter by package status

sort_bystring nullable

Sort field

Sort field

sort_directionstring nullable

Sort direction (asc or desc)

Sort direction (asc or desc)

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring

Unique identifier for the sold package

packageIdstring required

Package ID that was sold

patientIdstring required

Patient ID who purchased the package

chargeItemIdstring required

Charge item ID associated with the package purchase

status'USED' | 'ACTIVE' | 'CANCELLED' required
createdDatestring date-time required

Date the package was created

updatedDatestring date-time nullable

Date the package was updated

Changes

No recorded changes to this endpoint across all 1 revision of this API.