Sign in
provider
billing

Get Carts List

Get carts list with full details including items and packages. Similar to charge list endpoint structure.

get/billing/cart/list

Query parameters

patient_idstring nullable

Filter by patient ID

Filter by patient ID

status'DRAFT' | 'ABANDONED' | 'ACCEPTED' | 'REJECTED' | 'CONVERTED' | 'EXPIRED'

Status of a patient cart.

Filter by cart status

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring required

Cart ID

status'DRAFT' | 'ABANDONED' | 'ACCEPTED' | 'REJECTED' | 'CONVERTED' | 'EXPIRED' required

Status of a patient cart.

discountAmountinteger required

Total discount in cents

discountPercentagenumber required

Overall discount percentage

taxAmountinteger required

Total tax in cents

totalinteger required

Final total in cents

createdDatestring date-time nullable

Date the cart was created

updatedDatestring date-time nullable

Date the cart was last updated

expiresDatestring date-time nullable

When the cart expires

notesstring nullable

Notes about the cart

convertedChargeIdstring nullable

ID of charge if cart was converted

subtotalinteger required

Calculate subtotal from items after item-level discounts.

Changes

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