Usage and billing

​

What counts against your allowance

• Requests — every LIVE call your key makes that reaches an adapter (passes authentication, verification, scope and plan checks) counts, for the calendar month, once per successful authorize. A call refused before that point — an invalid key, a missing scope, an unverified workspace — never counts.
• Sandbox (test-key) traffic never counts against a billed allowance. It’s tracked separately, for your own visibility only.
• Connected clinics are counted as an average over the month, not a peak or a point-in-time count — a clinic you were connected to for the whole month counts fully; one you connected and disconnected the same day barely moves the number. This is deliberately immune to connecting a burst of clinics right before your bill closes.

​

Going over

• Extra requests are billed per 1,000 over your included amount.
• Extra connected clinics are billed per clinic, per month, over your included amount.

​

When a call IS refused for usage reasons

{
  "type": "https://developer.clinikehr.com/errors/quota_exceeded",
  "title": "Quota exceeded",
  "status": 429,
  "code": "quota_exceeded",
  "detail": "This workspace has used its included requests for this month under its current contract.",
  "request_id": "req_01example"
}

{
  "type": "https://developer.clinikehr.com/errors/limit_reached",
  "title": "Limit reached",
  "status": 403,
  "code": "limit_reached",
  "detail": "This workspace has reached its connected-clinic limit under its current contract.",
  "request_id": "req_01example"
}