Hint Health CustomerInvoice API
The CustomerInvoice API from Hint Health — 6 operation(s) for customerinvoice.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/hint-health-customerinvoice-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Hint Health Customer Invoice API
license:
name: Private
termsOfService: https://www.hint.com/terms
x-refined-note:
- x-api-evangelist-harvest differs across the merged source definitions and was not carried
version: '1.0'
description: 'Operations tagged CustomerInvoice across 2 of this provider''s published API definitions: hint-health-hint-health-api-openapi.yml, hint-health-partner-endpoints-2026-07-01-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
tags:
- name: CustomerInvoice
paths:
/provider/customer_invoices:
post:
tags:
- CustomerInvoice
operationId: CustomerInvoice.CreateCustomerInvoice
summary: Create Customer Invoice
description: ''
parameters: []
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one'
example:
id: inv-ab12C345DeF6
amount_in_cents: 4999
charges_count: 1
created_at: '2017-02-05T06:23:00.000000-08:00'
date: '2017-02-05'
due_in_cents: 4999
human_status: draft
integration_record_id: ABCD0012016
invoice_number: 1
last_sent_at: null
last_viewed_at: null
paid_at: null
paid_in_cents: 0
payment_status: null
payments_count: 0
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6
received_in_cents: 0
status: draft
subtotal_in_cents: 4999
tax_in_cents: 0
total_in_cents: 4999
updated_at: '2017-02-05T06:23:00.000000-08:00'
owner:
id: pat-ab12C345DeF6
address_city: New York
address_country: United States
address_line1: 157 E Houston St
address_line2: Suite 2402
address_state: NY
address_zip: '10002'
age: 65
chosen_first_name: null
chosen_last_name: null
chosen_middle_name: null
chosen_suffix: null
chosen_title: null
created_at: '2017-02-05T06:23:00.000000-08:00'
dob: '1952-01-01'
electronic_communication_consent_accepted: true
electronic_communication_consent_accepted_at: '2017-01-29T06:23:00.000000-08:00'
email: bass_man@bumblebeeinc.com
engaged: false
external_link_id: null
first_name: Gordon
gender: male
gender_identity: man
gender_other: null
health_insurance_group_id: '12345'
health_insurance_member_id: A22222222
health_insurance_payer_id: 00039
health_insurance_payer_name: Anthem Blue Cross California
hipaa_authorization_accepted: true
hipaa_authorization_accepted_at: '2017-01-29T06:23:00.000000-08:00'
import_id: null
import_source: null
joined_practice_date: '2017-02-05'
last_engagement_date: null
last_name: Sumner
lead_source_other: Downtown marketing event
master_record_sponsor: null
membership_status: active
middle_name: Thomas
name: Gordon Thomas Sumner
patient_agreement_accepted: false
patient_agreement_accepted_at: null
preferred_language: en
pronouns: null
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6
sex: male
suffix: null
terms_accepted: false
terms_accepted_at: null
updated_at: '2017-02-05T06:23:00.000000-08:00'
uses_tobacco: false
account:
name: Gordon Thomas Sumner
past_due_in_cents: 0
company:
id: com-ab12C345DeF6
name: Schmoogle Inc.
emergency_contact:
id: emc-ab12C345DeF6
first_name: Eliot
last_name: Sumner
email: bass_eliot@iblamecoco.com
name: Eliot Sumner
relationship: sibling
phone:
number: '5553050051'
type: mobile
us_formattable: true
external_records: []
known_practice: null
lead_source:
id: lds-ab12C345DeF6
name: Other
created_at: '2017-02-05T06:23:00.000000-08:00'
updated_at: '2017-02-05T06:23:00.000000-08:00'
location:
id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: null
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
membership_members: []
memberships: []
merged_into: null
phones: []
practitioner:
id: pct-ab12C345DeF6
accepts_enrollments_from_employer: true
accepts_enrollments_from_retail: true
bio: Reginalds biography...
created_at: '2017-02-05T06:23:00.000000-08:00'
education:
- The University of Hint
email: rocket_man@emi.com
gender: male
gender_other: null
integration_record_id: null
max_patient_age: 50
min_patient_age: 0
name: Reginald Dwight
online_signup_visibility: true
panel_size: 150
panel_size_limit: 200
photo_url: practitioners/000/000/115/photos/original.png
updated_at: '2017-02-05T06:23:00.000000-08:00'
locations:
- id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: '5553050019'
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
npi:
first_name: REGINALD
last_name: DWIGHT
number: 0123456879
organization_name: HINT HEALTH
type: individual
specialties:
- id: spe-ab12C345DeF6
name: Internal Medicine
practitioner_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
sponsorships:
- id: creg-ab12C345DeF6
external_id: ext_id_from_another_system012345
is_subscriber: true
type: employee
company:
id: com-ab12C345DeF6
name: Schmoogle Inc.
family:
id: cac-ab12C345DeF6
ssn:
masked_number: '***-**-1234'
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Provider.CustomerInvoicesController.create_body'
security:
- BearerAuth: []
get:
tags:
- CustomerInvoice
operationId: CustomerInvoice.ListAllCustomerInvoices
summary: List All Customer Invoices
description: ''
parameters:
- name: updated_at
in: query
required: false
description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information.
schema:
type: string
format: date-time
- name: created_at
in: query
required: false
description: Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See [advanced querying](https://developers.hint.com/reference/making-requests#advanced-querying) for more information.
schema:
type: string
format: date-time
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_all'
example:
- id: inv-ab12C345DeF6
amount_in_cents: 4999
charges_count: 1
created_at: '2017-02-05T06:23:00.000000-08:00'
date: '2017-02-05'
due_in_cents: 4999
human_status: draft
integration_record_id: ABCD0012011
invoice_number: 1
last_sent_at: null
last_viewed_at: null
paid_at: null
paid_in_cents: 0
payment_status: null
payments_count: 0
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6
received_in_cents: 0
status: draft
subtotal_in_cents: 4999
tax_in_cents: 0
total_in_cents: 4999
updated_at: '2017-02-05T06:23:00.000000-08:00'
owner:
id: pat-ab12C345DeF6
address_city: New York
address_country: United States
address_line1: 157 E Houston St
address_line2: Suite 2402
address_state: NY
address_zip: '10002'
age: 65
chosen_first_name: null
chosen_last_name: null
chosen_middle_name: null
chosen_suffix: null
chosen_title: null
created_at: '2017-02-05T06:23:00.000000-08:00'
dob: '1952-01-01'
electronic_communication_consent_accepted: true
electronic_communication_consent_accepted_at: '2017-01-29T06:23:00.000000-08:00'
email: bass_man@bumblebeeinc.com
engaged: false
external_link_id: null
first_name: Gordon
gender: male
gender_identity: man
gender_other: null
health_insurance_group_id: '12345'
health_insurance_member_id: A22222222
health_insurance_payer_id: 00039
health_insurance_payer_name: Anthem Blue Cross California
hipaa_authorization_accepted: true
hipaa_authorization_accepted_at: '2017-01-29T06:23:00.000000-08:00'
import_id: null
import_source: null
joined_practice_date: '2017-02-05'
last_engagement_date: null
last_name: Sumner
lead_source_other: Downtown marketing event
master_record_sponsor: null
membership_status: active
middle_name: Thomas
name: Gordon Thomas Sumner
patient_agreement_accepted: false
patient_agreement_accepted_at: null
preferred_language: en
pronouns: null
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6
sex: male
suffix: null
terms_accepted: false
terms_accepted_at: null
updated_at: '2017-02-05T06:23:00.000000-08:00'
uses_tobacco: false
account:
name: Gordon Thomas Sumner
past_due_in_cents: 0
company:
id: com-ab12C345DeF6
name: Schmoogle Inc.
emergency_contact:
id: emc-ab12C345DeF6
first_name: Eliot
last_name: Sumner
email: bass_eliot@iblamecoco.com
name: Eliot Sumner
relationship: sibling
phone:
number: '5553050051'
type: mobile
us_formattable: true
external_records: []
known_practice: null
lead_source:
id: lds-ab12C345DeF6
name: Other
created_at: '2017-02-05T06:23:00.000000-08:00'
updated_at: '2017-02-05T06:23:00.000000-08:00'
location:
id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: null
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
membership_members: []
memberships: []
merged_into: null
phones: []
practitioner:
id: pct-ab12C345DeF6
accepts_enrollments_from_employer: true
accepts_enrollments_from_retail: true
bio: Reginalds biography...
created_at: '2017-02-05T06:23:00.000000-08:00'
education:
- The University of Hint
email: rocket_man@emi.com
gender: male
gender_other: null
integration_record_id: null
max_patient_age: 50
min_patient_age: 0
name: Reginald Dwight
online_signup_visibility: true
panel_size: 150
panel_size_limit: 200
photo_url: practitioners/000/000/115/photos/original.png
updated_at: '2017-02-05T06:23:00.000000-08:00'
locations:
- id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: '5553050019'
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
npi:
first_name: REGINALD
last_name: DWIGHT
number: 0123456879
organization_name: HINT HEALTH
type: individual
specialties:
- id: spe-ab12C345DeF6
name: Internal Medicine
practitioner_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
sponsorships:
- id: creg-ab12C345DeF6
external_id: ext_id_from_another_system012345
is_subscriber: true
type: employee
company:
id: com-ab12C345DeF6
name: Schmoogle Inc.
family:
id: cac-ab12C345DeF6
ssn:
masked_number: '***-**-1234'
integration_error_message: null
integration_last_synced_at: null
integration_record_id: null
integration_sync_status: enabled
integration_web_link: null
headers:
X-Count:
description: The number of resources returned in this request
schema:
type: integer
X-Total-Count:
description: The total number of resources available (scoped to query params)
schema:
type: integer
security:
- BearerAuth: []
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
/provider/customer_invoices/{customer_invoice_id}/pdf:
post:
tags:
- CustomerInvoice
operationId: CustomerInvoice.CreatePDF
summary: Generate PDF for Customer Invoice
description: "## Usage Instructions and Security Best Practices\n - **Link Expiration:** Links expire after 15 minutes.\n - **Authenticate Users:** Only generate pdf links for authenticated users.\n - **On-Demand Links:** Generate the link only when a user requests to view or download a pdf.\n - **New Windows/Tabs:** Automatically redirect users to the URL provided, instead of showing them the link\n directly.\n - **Avoid Caching:** Do not cache or store pdf links in your application.\n - **Avoid Email Transmission:** Never send pdf links via email due to link expiry and security concerns.\n## Example Workflow\n 1. **Request Access:** User logs into your system and requests to view a pdf.\n 2. **Generate Link:** Your system makes a POST request to the pdf endpoint.\n 3. **Provide Link:** Your application receives the URL and automatically redirects the user to the URL in a new\n window or tab."
parameters:
- name: customer_invoice_id
in: path
required: true
description: Unique Customer Invoice ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.PdfBlueprint_one'
example:
url: https://api.hint.com/api/files/0jlsWoWWS2M6?account_token=example_token
security:
- BearerAuth: []
servers:
- url: https://api.hint.com/api
description: Production
- url: https://api.sandbox.hint.com/api
description: Sandbox
/provider/customer_invoices/{id}:
delete:
tags:
- CustomerInvoice
operationId: CustomerInvoice.DeleteCustomerInvoice
summary: Delete Customer Invoice
description: ''
parameters:
- name: id
in: path
required: true
description: Unique Customer Invoice ID
schema:
type: string
responses:
'204':
description: No content
security:
- BearerAuth: []
get:
tags:
- CustomerInvoice
operationId: CustomerInvoice.ShowCustomerInvoice
summary: Show Customer Invoice
description: '**Status Options:** draft, issued, sent, cancelled, retrying, bad_debt, paid, disputed
**Human Status Options:** draft, issued, sent, cancelled, bank_not_verified, needs_payment_info, retrying, bad_debt, paid, disputed'
parameters:
- name: id
in: path
required: true
description: Unique Customer Invoice ID
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/Public.CustomerInvoiceBlueprint_one'
example:
id: inv-ab12C345DeF6
amount_in_cents: 4999
charges_count: 1
created_at: '2017-02-05T06:23:00.000000-08:00'
date: '2017-02-05'
due_in_cents: 4999
human_status: draft
integration_record_id: ABCD0012016
invoice_number: 1
last_sent_at: null
last_viewed_at: null
paid_at: null
paid_in_cents: 0
payment_status: null
payments_count: 0
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6/charges/inv-ab12C345DeF6
received_in_cents: 0
status: draft
subtotal_in_cents: 4999
tax_in_cents: 0
total_in_cents: 4999
updated_at: '2017-02-05T06:23:00.000000-08:00'
owner:
id: pat-ab12C345DeF6
address_city: New York
address_country: United States
address_line1: 157 E Houston St
address_line2: Suite 2402
address_state: NY
address_zip: '10002'
age: 65
chosen_first_name: null
chosen_last_name: null
chosen_middle_name: null
chosen_suffix: null
chosen_title: null
created_at: '2017-02-05T06:23:00.000000-08:00'
dob: '1952-01-01'
electronic_communication_consent_accepted: true
electronic_communication_consent_accepted_at: '2017-01-29T06:23:00.000000-08:00'
email: bass_man@bumblebeeinc.com
engaged: false
external_link_id: null
first_name: Gordon
gender: male
gender_identity: man
gender_other: null
health_insurance_group_id: '12345'
health_insurance_member_id: A22222222
health_insurance_payer_id: 00039
health_insurance_payer_name: Anthem Blue Cross California
hipaa_authorization_accepted: true
hipaa_authorization_accepted_at: '2017-01-29T06:23:00.000000-08:00'
import_id: null
import_source: null
joined_practice_date: '2017-02-05'
last_engagement_date: null
last_name: Sumner
lead_source_other: Downtown marketing event
master_record_sponsor: null
membership_status: active
middle_name: Thomas
name: Gordon Thomas Sumner
patient_agreement_accepted: false
patient_agreement_accepted_at: null
preferred_language: en
pronouns: null
provider_web_link: https://app.hint.com/patients/pat-ab12C345DeF6
sex: male
suffix: null
terms_accepted: false
terms_accepted_at: null
updated_at: '2017-02-05T06:23:00.000000-08:00'
uses_tobacco: false
account:
name: Gordon Thomas Sumner
past_due_in_cents: 0
company:
id: com-ab12C345DeF6
name: Schmoogle Inc.
emergency_contact:
id: emc-ab12C345DeF6
first_name: Eliot
last_name: Sumner
email: bass_eliot@iblamecoco.com
name: Eliot Sumner
relationship: sibling
phone:
number: '5553050051'
type: mobile
us_formattable: true
external_records: []
known_practice: null
lead_source:
id: lds-ab12C345DeF6
name: Other
created_at: '2017-02-05T06:23:00.000000-08:00'
updated_at: '2017-02-05T06:23:00.000000-08:00'
location:
id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: null
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
membership_members: []
memberships: []
merged_into: null
phones: []
practitioner:
id: pct-ab12C345DeF6
accepts_enrollments_from_employer: true
accepts_enrollments_from_retail: true
bio: Reginalds biography...
created_at: '2017-02-05T06:23:00.000000-08:00'
education:
- The University of Hint
email: rocket_man@emi.com
gender: male
gender_other: null
integration_record_id: null
max_patient_age: 50
min_patient_age: 0
name: Reginald Dwight
online_signup_visibility: true
panel_size: 150
panel_size_limit: 200
photo_url: practitioners/000/000/115/photos/original.png
updated_at: '2017-02-05T06:23:00.000000-08:00'
locations:
- id: loc-ab12C345DeF6
address_city: New York
address_country: United States
address_latitude: 40.7227998
address_line1: 157 E Houston St
address_line2: Suite 2402
address_longitude: -73.9892241
address_state: NY
address_zip: '10002'
distance: null
name: San Francisco HQ
phone_number: '5553050019'
virtual: false
location_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
npi:
first_name: REGINALD
last_name: DWIGHT
number: 0123456879
organization_name: HINT HEALTH
type: individual
specialties:
- id: spe-ab12C345DeF6
name: Internal Medicine
practitioner_group:
id: prg-ab12C345DeF6
created_at: '2017-02-05T06:23:00.000000-08:00'
integration_record_id: null
name: Downtown Location Group
updated_at: '2017-02-05T06:23:00.000000-08:00'
sponsorships:
- id: creg-ab12C345DeF6
external_id: ext_id_from_another_system012345
is_subscriber: true
type: employee
company:
id: com-ab12C345DeF6
# --- truncated at 32 KB (105 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hint-health/refs/heads/main/openapi/hint-health-customerinvoice-api-openapi.yml