Skip to navigation
API ReferenceBillingEstimate Charges

Create Estimate Charge

GA

This endpoint can only be used after setting up the billing integration. Refer to the billing integration documentation for more details.

This endpoint may return a 409 error response with one of these public message values:

  • Conflicting EstimateCharge exists
  • Missing Service Eligibility Amount

Authentication

X-API-Keystring
API Key authentication via header

Request

This endpoint expects an object.
patientIdstringRequired
serviceEligibilityIdstringRequired
externalIdstringOptional

Response

This endpoint returns an object.
idstring
createdAtdatetime
updatedAtdatetime
patientIdstring
serviceEligibilityIdstring
amountinteger
statusenum
externalIdstringOptional