Skip to navigation
API ReferenceBillingEstimate Charges

Authorize stripe 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:

  • Invalid Estimate Charge Status
  • Missing Customer
  • Missing Customer Payment Method
  • Payment Already Captured
  • Payment has been Voided

Authentication

X-API-Keystring
API Key authentication via header

Path parameters

idstringRequired

Response

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