Get Cart By Id

curl --request GET \
  --url https://api.decodahealth.com/billing/cart/{cart_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>"
  },
  "status": "DRAFT",
  "discountAmount": 123,
  "discountPercentage": 123,
  "taxAmount": 123,
  "total": 123,
  "subtotal": 123,
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "items": [],
  "quotes": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "creatorId": "<string>",
      "cartId": "<string>",
      "title": "<string>",
      "itemCount": 0,
      "packageCount": 0,
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "validUntilDate": "2023-11-07T05:31:56Z",
      "sentDate": "2023-11-07T05:31:56Z",
      "viewedDate": "2023-11-07T05:31:56Z",
      "respondedDate": "2023-11-07T05:31:56Z",
      "internalNotes": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      }
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "expiresDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "convertedChargeId": "<string>"
}

GET

billing

cart

{cart_id}

Get Cart By Id

curl --request GET \
  --url https://api.decodahealth.com/billing/cart/{cart_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "id": "<string>",
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>"
  },
  "status": "DRAFT",
  "discountAmount": 123,
  "discountPercentage": 123,
  "taxAmount": 123,
  "total": 123,
  "subtotal": 123,
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "items": [],
  "quotes": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "creatorId": "<string>",
      "cartId": "<string>",
      "title": "<string>",
      "itemCount": 0,
      "packageCount": 0,
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "validUntilDate": "2023-11-07T05:31:56Z",
      "sentDate": "2023-11-07T05:31:56Z",
      "viewedDate": "2023-11-07T05:31:56Z",
      "respondedDate": "2023-11-07T05:31:56Z",
      "internalNotes": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>"
      }
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "expiresDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "convertedChargeId": "<string>"
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

cart_id

string

required

Response

Successful Response

Summary schema for cart with basic details.

string

required

Cart ID

patient

PatientSummary · object

required

Patient details

Show child attributes

patient.id

string

required

The unique identifier for the user.

patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

patient.createdDate

string<date-time>

required

The date and time when the user was created.

patient.firstName

string | null

The user's first name.

patient.lastName

string | null

The user's last name.

patient.phoneNumber

string | null

The user's phone number.

patient.email

string | null

The user's email address.

patient.locationId

string | null

The location of the user.

patient.externalId

string | null

The user's external identifier if available.

patient.address

string | null

The user's primary address.

patient.addressLineTwo

string | null

Additional address information.

patient.city

string | null

The city of the user's address.

patient.state

string | null

The state of the user's address.

patient.zipCode

string | null

The postal code of the user's address.

patient.country

string | null

The country of the user's address.

patient.addressValid

boolean | null

Whether the user's address is valid.

patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

patient.isArchived

boolean | null

Whether the user is archived.

patient.primaryLocationId

string | null

The primary location of the user.

patient.gender

string | null

The gender of the patient.

patient.dateOfBirth

string<date> | null

The date of birth of the patient.

patient.patientMedications

string[] | null

List of patient's self-reported medications.

patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

patient.tags.id

string

required

Unique identifier for the patient tag

patient.tags.name

string

required

Name of the patient tag

patient.tags.isActive

boolean

required

Whether the tag is active

patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

patient.tags.emoji

string | null

Emoji associated with the tag

patient.tags.color

string | null

Color code for the tag (hex format)

patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

patient.creditBalance

integer | null

Patient's credit balance in cents.

patient.preferredProviderId

string | null

The preferred provider ID for this patient.

status

enum<string>

required

Cart status

Available options:

DRAFT,

ABANDONED,

ACCEPTED,

REJECTED,

CONVERTED,

EXPIRED

discountAmount

integer

required

Total discount in cents

discountPercentage

number

required

Overall discount percentage

taxAmount

integer

required

Total tax in cents

total

integer

required

Final total in cents

subtotal

integer

required

Calculate subtotal from items after item-level discounts.

creator

ProviderTiny · object

Creator details

Show child attributes

creator.id

string

required

creator.firstName

string

required

creator.lastName

string | null

creator.email

string | null

creator.createdDate

string<date-time> | null

items

CartItem · object[]

Items and packages in the cart

Show child attributes

items.id

string

required

Cart item ID

items.cartId

string

required

ID of the cart

items.quantity

number

required

Quantity of the item/package

items.unitPrice

integer

required

Unit price in cents

items.discountAmount

integer

required

Discount amount in cents

items.discountPercentage

number

required

Discount percentage

items.taxAmount

integer

required

Tax amount in cents

items.totalPrice

integer

required

Total price for this quantity in cents

items.itemId

string | null

ID of the item

items.packageId

string | null

ID of the package

items.notes

string | null

Notes about this item/package

items.item

ItemTiny · object

Item details

Show child attributes

items.item.name

string

required

Name of the item

items.item.price

integer

required

Price of the item in cents

items.item.id

string

Unique identifier for the item

items.item.brandName

string | null

Optional brand name of the item

items.item.description

string | null

Optional description of the item

items.item.category

string | null

Category name (references category.name)

items.item.unit

enum<string> | null

Unit of measurement for the item

Available options:

AMPOULES,

APPLICATORS,

BOTTLES,

BOXES,

CAPSULES,

CUPS,

DOSES,

G_PER_ML,

GRAMS,

IU,

IU_PER_ML,

OUNCES,

FLUID_OUNCES,

KG,

KITS,

LITERS,

MCG,

MG,

MG_PER_ML,

ML,

MMOL,

MICROGRAM_PER_ML,

PACKS,

PAIRS,

PATCHES,

PERCENTAGE,

PIECES,

POUCHES,

ROLLS,

SACHETS,

SHEETS,

SPRAYS,

STRIPS,

SYRINGES,

TABLETS,

TABLETS_PER_DAY,

TESTS,

TUBES,

UNITS,

VIALS,

TREATMENTS,

SESSIONS,

PULSES,

JOULES,

CENTIMETERS,

THREAD_COUNT,

INJECTIONS,

WRINKLE_UNITS,

POUNDS,

FEET,

INCHES

items.item.isPhysical

boolean

default:true

Whether the item is physical

items.item.isArchived

boolean

default:false

Whether the item is archived

items.item.internalNotes

string | null

Optional internal notes for the item

items.item.taxable

boolean

default:false

Whether the item is subject to taxes

items.item.sortOrder

integer | null

Optional sort order for the item

items.item.allowCustomPricing

boolean

default:false

Whether custom pricing is allowed for this item

items.item.type

enum<string>

default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:

ITEM,

PRODUCT,

MEDICATION,

SERVICE,

PACKAGE,

MEMBERSHIP

items.package

PackageTiny · object

Package details

Show child attributes

items.package.name

string

required

Name of the package

items.package.price

integer

required

Price of the package in cents

items.package.id

string

Unique identifier for the package

items.package.description

string | null

Optional description of the package

items.package.isArchived

boolean

default:false

Whether the package is archived

items.createdDate

string<date-time> | null

Date the item was added

items.updatedDate

string<date-time> | null

Date the item was last updated

quotes

QuoteSummary · object[]

Quotes created from this cart

Show child attributes

quotes.id

string

required

Quote ID

quotes.patientId

string

required

Patient ID

quotes.status

enum<string>

required

Quote status

Available options:

DRAFT,

SENT,

VIEWED,

ACCEPTED,

DECLINED,

EXPIRED,

CONVERTED

quotes.discountAmount

integer

required

Total discount in cents

quotes.discountPercentage

number

required

Overall discount percentage

quotes.taxAmount

integer

required

Total tax in cents

quotes.total

integer

required

Final total in cents

quotes.creatorId

string | null

Creator ID

quotes.cartId

string | null

Source cart ID

quotes.title

string | null

Title/subject of the quote

quotes.itemCount

integer

default:0

Number of items in quote

quotes.packageCount

integer

default:0

Number of packages in quote

quotes.createdDate

string<date-time> | null

Date the quote was created

quotes.updatedDate

string<date-time> | null

Date the quote was last updated

quotes.validUntilDate

string<date-time> | null

When the quote expires

quotes.sentDate

string<date-time> | null

When the quote was sent

quotes.viewedDate

string<date-time> | null

When the patient first viewed the quote

quotes.respondedDate

string<date-time> | null

When the patient responded to the quote

quotes.internalNotes

string | null

Internal notes

quotes.creator

ProviderTiny · object

Creator details

Show child attributes

quotes.creator.id

string

required

quotes.creator.firstName

string

required

quotes.creator.lastName

string | null

quotes.creator.email

string | null

quotes.creator.createdDate

string<date-time> | null

quotes.patient

PatientSummary · object

Patient details

Show child attributes

quotes.patient.id

string

required

The unique identifier for the user.

quotes.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

quotes.patient.createdDate

string<date-time>

required

The date and time when the user was created.

quotes.patient.firstName

string | null

The user's first name.

quotes.patient.lastName

string | null

The user's last name.

quotes.patient.phoneNumber

string | null

The user's phone number.

quotes.patient.email

string | null

The user's email address.

quotes.patient.locationId

string | null

The location of the user.

quotes.patient.externalId

string | null

The user's external identifier if available.

quotes.patient.address

string | null

The user's primary address.

quotes.patient.addressLineTwo

string | null

Additional address information.

quotes.patient.city

string | null

The city of the user's address.

quotes.patient.state

string | null

The state of the user's address.

quotes.patient.zipCode

string | null

The postal code of the user's address.

quotes.patient.country

string | null

The country of the user's address.

quotes.patient.addressValid

boolean | null

Whether the user's address is valid.

quotes.patient.meta

Meta · object

Any additional metadata about the user relevant to your system.

quotes.patient.isArchived

boolean | null

Whether the user is archived.

quotes.patient.primaryLocationId

string | null

The primary location of the user.

quotes.patient.gender

string | null

The gender of the patient.

quotes.patient.dateOfBirth

string<date> | null

The date of birth of the patient.

quotes.patient.patientMedications

string[] | null

List of patient's self-reported medications.

quotes.patient.onSchedulingBlacklist

boolean | null

Whether the patient is on the scheduling blacklist.

quotes.patient.surchargeDisabled

boolean | null

Whether surcharges are disabled for this patient.

quotes.patient.tags

PatientTagSummary · object[] | null

List of patient tags

Show child attributes

quotes.patient.tags.id

string

required

Unique identifier for the patient tag

quotes.patient.tags.name

string

required

Name of the patient tag

quotes.patient.tags.isActive

boolean

required

Whether the tag is active

quotes.patient.tags.createdDate

string<date-time>

required

Date and time when the tag was created

quotes.patient.tags.emoji

string | null

Emoji associated with the tag

quotes.patient.tags.color

string | null

Color code for the tag (hex format)

quotes.patient.tags.updatedDate

string<date-time> | null

Date and time when the tag was last updated

quotes.patient.creditBalance

integer | null

Patient's credit balance in cents.

quotes.patient.preferredProviderId

string | null

The preferred provider ID for this patient.

createdDate

string<date-time> | null

Date the cart was created

updatedDate

string<date-time> | null

Date the cart was last updated

expiresDate

string<date-time> | null

When the cart expires

notes

string | null

Notes about the cart

convertedChargeId

string | null

ID of charge if cart was converted

Get Available Months Get Carts

⌘I

Getting Started

API

Tenant

Webhook

Get Cart By Id

Headers

Path Parameters

Response