API Reference

Insurance Claims

🚧

This endpoint is in beta and as such all content below is subject to change. Please note that all ledger data below should only be accessed via the v20240412 version. Ledger data requires additional setup so please reach out to [email protected] before building on these endpoints.

Overview


Use Cases

payment_estimate_total

The amount the insurance company is estimated to pay

Subscription_id


Status

There are 7 status for insurance claim (draft, sent, received, approved, paid, rejected, canceled). All but paid are considered pending internally and are used to calculate the insurance estimate field.

Finalized_at

sent_at


Understanding Write Offs

Write_off_estimate_total is the amount we expect to write off once the claims is finished/complete and write_off_total is the value that was actually write off after the process finished. So you use write_off_estimate_total before the claims is finished/complete and write_off_total after.