Sign in
provider
billing

Get Charge Timeline

Get a timeline of events for a specific charge or payment. This will include all related charges, payments, adjustments, and refunds.

get/billing/charge/timeline

Query parameters

charge_idstring nullable
payment_idstring nullable

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring required
type'CHARGE' | 'PAYMENT' | 'REFUND' | 'VOID' | 'ADJUSTMENT' | 'EXTERNAL_SETTLEMENT' | 'WRITE_OFF' | 'SCHEDULED_PAYMENT' | 'FAILED_PAYMENT' required
amountinteger required
datestring date-time required
paymentMediumstring nullable
commentstring nullable
descriptionstring nullable
refundReasonstring nullable
discountAmountinteger nullable
feeToPatientinteger nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.