Patient billing

Remove a price

  • Sandbox: available
  • On your own host? Choose https://{host} in the playground.
DELETE
/v1/patient-billing/prices/{priceId}

Takes a price off the price list. New charges for its code then need a new price or a priceOverride.

Scope: a project admin or an admin ClientApplication, in a project with PATIENT_BILLING_ENABLED on. Anyone else: 403 PATIENT_BILLING_NOT_ALLOWED.

Behaviour

  • The price is retired, not deleted, so the charges entered at it still name it. Removing it again answers 204 too.
  • Setting the code's price again (POST /v1/patient-billing/prices) puts it back on the list.

Example

curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/prices/<priceId>' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

priceId*string

The price id.

Match^[A-Za-z0-9\-.]{1,64}$

Response Body

Off the price list: retired, so the charges entered at it still name it.

Example Request
curl -X DELETE 'https://api.sandbox.ovok.com/v1/patient-billing/prices/string'
Example Response
Empty