Sign in
provider
billing

Create Cart

Create a new cart with items and packages.

This endpoint creates a cart similar to how charges are created, handling items, packages, discounts, and pricing calculations.

post/billing/cart

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring nullable

Cart ID (auto-generated if not provided)

patientIdstring required

ID of the patient

creatorIdstring nullable

ID of the user creating the cart

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

Status of a patient cart.

notesstring nullable

Notes about the cart

expiresDatestring date-time nullable

When the cart expires

discountAmountinteger

Overall cart discount in cents

discountPercentagenumber

Overall cart discount percentage

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.