Get Draft Charge
Fetch a draft charge for resuming in checkout.
New drafts carry the exact checkout payload in meta[“draft_payload”] and are returned from it verbatim (with fresh patient data). Drafts migrated from legacy carts have no payload and are serialized from their rows.
This is the only complete view of a draft. save_draft_charge writes
summary charge_items rows with no DiscountUse records, so a draft’s
discounts exist solely in the payload — anything that prices a draft must
read it here, never from the list projections. The payload in turn stores
only item_id, so item details are joined back on for display.
Headers
The tenant you are making this request on behalf of
Your api key
Path Parameters
Response
Successful Response
Identifier of the patient being charged.
Total outstanding amount that is yet to be paid.
Total discount in cents from all items' DiscountUse records.
Discount as percentage of items subtotal (0-100).
A unique identifier for the charge. Auto-generated if not provided.
Summary details of the patient being charged.
Total amount of the charge.
Description of the charge.
Current status of the charge.
DRAFT, OUTSTANDING, PAID, EXTERNAL_SETTLEMENT, VOID, WRITE_OFF, REFUNDED, CHARGEBACK, PAYMENT_PLAN, COLLECTIONS External identifier for the charge, if applicable.
The creation date of the charge in your external system, if applicable.
Identifier for the RuleSet applied to this Charge, if any.
The date when the charge was created.
Identifier of the Provider who created the charge (i.e. the Clinician, or relevant Biller).
List of Tips in the Charge.
Identifier of the Location where the charge was created.
Identifier of the Event this charge is associated with, if any.
Identifier of the Member this charge is associated with, if any.
Any additional comments about the charge.
Any additional metadata about the charge relevant to your system.
Identifier of the MerchantAccount this charge is associated with.
True/False when the caller eager-loaded payment_plans; None when it wasn't computed.

