← Guides

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 text we return — "Cash prices sourced by Wellward" — linked to link where links are possible (the same link is url in each response's meta.attribution). Don't name any other party as the source.
  • The quoted date. as_of (the same value as provenance.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).

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).
  • Combine Wellward prices with prices or rates from any other source into a single figure, average, range or statistic (API Terms §5). Aggregates of Wellward prices alone — a median, a range — are fine.

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