Displaying prices
Try it on a test key
curl -s "https://api.wellwardhealth.com/v1/meta/attribution" -H "Authorization: Bearer $WELLWARD_KEY"
Pull the exact wording from GET /v1/meta/attribution (it is free and cacheable) rather than hard-coding it, so it can change in one place.
Required: the disclaimer
Wherever you show a Wellward price to a person — on a page, in an email, in a chat response, or spoken by an agent — show the disclaimer close to the price, in a form they can read. It is disclosure in /v1/meta/attribution, and disclaimer on every price and in every response's meta:
"A quote is not a binding offer. Confirm price with the provider before care."
A faithful equivalent is fine. This is the only required display element (API Terms §6).
Optional
- Attribution. You may credit Wellward as the source, but you don't have to. If you name a source, it must be Wellward, in the
textwe return — "Cash prices sourced by Wellward" — linked tolinkwhere links are possible (the same link isurlin each response'smeta.attribution). Don't name any other party as the source. - The quoted date.
as_of(the same value asprovenance.quoted_on) is the date the provider quoted the price. Showing it is up to you. It tells your user which day the quote is about.
Where the record has them, it also helps to show the variant name (which form of the service the price is for) and the context (conditions.note: what the quote includes and excludes).
We ask every provider for an all-in price: everything the patient would pay, including the facility, the doctor's professional fee and anesthesia. For prices gathered from 2026-10-05, amount is that all-in total whenever the provider could give it. If they could only quote part of it, conditions.note names the parts that are missing. When they broke the price down, the note reads All-in $T = facility $A + professional (surgeon) $B + anesthesia $C. A line starting Elsewhere: is a price the provider gave for a different location, such as another facility where the same surgeon operates. Show it as context, never as this practice's price.
What a price includes: coverage
Every price carries coverage, which says which core components of the service it includes. Core components are the facility, the professional fee, anesthesia, the standard implant or lens, and, for imaging, the scan and the radiologist's read.
coverage.all_in | Means | How to show it |
|---|---|---|
true | every core component is in amount | as the price of the service |
false | a component price: part of the service, such as the surgeon's fee alone. excludes names what isn't in it | label it as that part, e.g. "Surgeon's fee — facility and anesthesia billed separately". Never show it as the price of the service |
null | not established for this price | as the price, with conditions.note for detail |
Component prices only reach you by id, typically from a price request. Search, sorting and benchmarks never include them.
Component amounts
coverage.components lists each core component with its status and, when the provider stated it, its own amount:
"amount": { "cents": 1912677, "currency": "USD", "display": "$19,127" },
"coverage": {
"all_in": false,
"includes": ["facility", "professional"],
"excludes": ["anesthesia"],
"components": [
{ "component": "facility", "status": "included", "amount": { "cents": 1475677, "currency": "USD", "display": "$14,757" } },
{ "component": "professional", "status": "included", "amount": { "cents": 437000, "currency": "USD", "display": "$4,370" } },
{ "component": "anesthesia", "status": "excluded", "amount": null }
]
}
- Show an
includedamount as part of the price ("Facility $14,756.77 + physician $4,370"). When every included component has an amount, they add up toamount. - Show an
excludedamount as billed separately, on top ("Anesthesia billed separately, quoted $800"). amount: nullmeans the provider didn't state that part on its own (or gave a range). Don't fill it in by subtracting.
Add-ons
A core price may carry addons[], things billed on top of it (pathology on a colonoscopy, contrast on an MRI). Show them as add-ons to the core price, never as prices on their own. If you asked for add-ons with addons=, they are already included in amount and marked included_in_amount: true.
Never
- Remove or alter the disclaimer.
- Call a price guaranteed, contracted, negotiated, in-network, a discount, or a Wellward-set price, or present it as more current, certain or official than it is.
- Describe Wellward as a network, plan, payer, or party to the purchase.
- Show a price after it has been withdrawn (see Keep prices current).
as_of is context, not a quality signal
Every price we return is inside our freshness window and currently valid. Keeping it that way is our job, so you don't need to filter by age.
API reference · Dashboard · Questions: hello@wellwardhealth.com