AccountAccessToken1

Affiliate2

AffiliateAncillaryCharge1

AffiliateBill1

AffiliatePatient2

Allergy4

ApiKey2

App3

Appointment2

AppRevision3

AppSurface3

Backend3

BankAccount3

CancellationReason1

Card4

Charge1

ChargeItem5

ClinicalNoteInteraction3

CommunicationAuthorization3

Company5

CompanyPlan4

Coupon2

Credit3

CreditCategory5

CreditLine1

CustomerInvoice10

CustomerInvoiceCharge3

CustomerInvoicePayment3

Diagnosis4

DocumentInteraction3

EmployeeDivision1

FamilyHistory4

FormInteraction1

FormResponse2

Installation5

InstallationApiKeys4

InstallationWebhookEndpoints4

IntegrationRecord1

Interaction2

InteractionFile3

InteractionNotifications1

Invoice2

InvoicePayment3

LabInteraction3

LeadSource4

Location5

Medications4

Membership9

MembershipContract3

MembershipMember6

Partner2

PartnerCharge3

PartnerInteraction3

PartnerPracticeCredential3

PartnerProductHighlight4

PartnerProductLink4

PartnerProductOverview2

PartnerProductPrecondition4

Patient6

PatientFile1

PaymentMethod5

Plan1

Practice2

Practitioner5

Prescriptions1

Product6

ProductCategory4

Prospect5

Quote1

RefillNotifications5

Service6

SignupAttempt2

SocialHistory4

SocialSecurityNumber1

Sponsorship5

Supplements5

Surgery4

Testimonial4

User1

VitalsInteraction1

WebhookEndpoint4

WebhookEvent1

WebhookRequest1

CustomerInvoice

Show Customer Invoice

Changed on Nov 3, 2026

Status Options: draft, issued, sent, cancelled, retrying, bad_debt, paid, disputed Human Status Options: draft, issued, sent, cancelled, retrying, bad_debt, paid, disputed, needs_payment_info, failed_payment human_status equals status, except for an issued, sent, or retrying invoice whose payment method (the scheduled one, else the owner's default) is missing or not expected to succeed. That invoice is failed_payment when it has a payment method and a failed payment, and needs_payment_info otherwise. cancelled is the status of a voided invoice. The void reason and timestamp are not exposed.

get/provider/customer_invoices/{id}

Request

Base URL
https://api.sandbox.hint.com/api
URL
https://api.sandbox.hint.com/api/provider/customer_invoices/{id}
Auth
API key in header AUTHORIZATION

Path parameters

idstring required

Unique Customer Invoice ID

Response

Successful response

idstring

amount_in_centsinteger

charges_countinteger

created_atstring date-time

datestring date

due_in_centsinteger

human_statusstring

integration_record_idstring

invoice_numberinteger

last_sent_atstring date-time

last_viewed_atstring date-time

paid_atstring date-time

paid_in_centsinteger

payment_statusstring

payments_countinteger

provider_web_linkstring

received_in_centsinteger

cancelled is the status of a voided invoice. There is no refunded status: a refund on a paid invoice moves it back to issued or sent.

subtotal_in_centsinteger

tax_in_centsinteger

total_in_centsinteger

updated_atstring date-time

Changes

Nov 3, 2026c9bda0d2dd87 Revision changes
- warning
  added the new bad_debt enum value to the response property for the response status
- warning
  added the new cancelled enum value to the response property for the response status
- warning
  added the new disputed enum value to the response property for the response status
- warning
  added the new draft enum value to the response property for the response status
- warning
  added the new issued enum value to the response property for the response status
- warning
  added the new paid enum value to the response property for the response status
- warning
  added the new retrying enum value to the response property for the response status
- warning
  added the new sent enum value to the response property for the response status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  response property charges/patient/patient_agreement_accepted deprecated
- info
  response property charges/patient/patient_agreement_accepted_at deprecated
- info
  response property charges/patient/terms_accepted deprecated
- info
  response property charges/patient/terms_accepted_at deprecated
- info
  response property owner/patient_agreement_accepted deprecated
- info
  response property owner/patient_agreement_accepted_at deprecated
- info
  response property owner/terms_accepted deprecated
- info
  response property owner/terms_accepted_at deprecated

Operation history

Show Customer Invoice

Request

Path parameters

Response 200OK

Changes

Response