openapi: 3.0.3 info: title: Hint Health AccountAccessToken CustomerInvoiceCharge API description: REST API providing programmatic access to Hint Health's direct primary care platform, covering patient and membership management, billing, charges, invoices, clinical data, practice configuration, partner integrations, and webhook event delivery. version: '1.0' contact: name: Hint Health Developer Support email: devsupport@hint.com url: https://developers.hint.com license: name: Private termsOfService: https://www.hint.com/terms servers: - url: https://api.hint.com/api description: Production - url: https://api.sandbox.hint.com/api description: Sandbox security: - BearerAuth: [] tags: - name: CustomerInvoiceCharge paths: /provider/customer_invoices/{customer_invoice_id}/charges: post: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.CreateCustomerInvoiceCharge summary: Create CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string responses: '201': description: Successful response content: application/json: example: id: cha-ab12C345DeF6 amount_in_cents: 1000 created_at: '2017-02-05T06:23:00.000000-08:00' description: '' is_persisted: true name: Lab fee price_in_cents: 1000 quantity: 1 service_date: '2017-02-05' status: draft subtotal_in_cents: 1000 tax_in_cents: 0 total_in_cents: 1000 updated_at: '2017-02-05T06:23:00.000000-08:00' category: null charge_item: null location: id: loc-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' name: San Francisco HQ patient: 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: i_heart_rufus@chaka.com engaged: false external_link_id: null first_name: Yvette 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: Stevens lead_source_other: Downtown marketing event master_record_sponsor: null membership_status: active middle_name: Thomas name: Yvette Thomas Stevens 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: Yvette Thomas Stevens 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 practitioner: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoices.ChargesController.create_body' /provider/customer_invoices/{customer_invoice_id}/charges/{id}: delete: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.DeleteCustomerInvoiceCharge summary: Delete CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string - name: id in: path required: true description: Unique Customer Invoice Charge ID schema: type: string responses: '204': description: No content patch: tags: - CustomerInvoiceCharge operationId: CustomerInvoiceCharge.UpdateCustomerInvoiceCharge summary: Update CustomerInvoiceCharge description: '' parameters: - name: customer_invoice_id in: path required: true description: Unique Customer Invoice ID schema: type: string - name: id in: path required: true description: Unique Customer Invoice Charge ID schema: type: string responses: '200': description: Successful response content: application/json: example: id: cha-ab12C345DeF6 amount_in_cents: 1000 created_at: '2017-02-05T06:23:00.000000-08:00' description: '' is_persisted: true name: Lab fee price_in_cents: 1000 quantity: 1 service_date: '2017-02-05' status: draft subtotal_in_cents: 1000 tax_in_cents: 0 total_in_cents: 1000 updated_at: '2017-02-05T06:23:00.000000-08:00' category: null charge_item: null location: id: loc-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' name: San Francisco HQ patient: 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: i_heart_rufus@chaka.com engaged: false external_link_id: null first_name: Yvette 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: Stevens lead_source_other: Downtown marketing event master_record_sponsor: null membership_status: active middle_name: Thomas name: Yvette Thomas Stevens 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: Yvette Thomas Stevens 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 practitioner: null requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Provider.CustomerInvoices.ChargesController.update_body' components: schemas: Provider.CustomerInvoices.ChargesController.update_body: type: object properties: quantity: type: number format: double price_in_cents: type: number format: double name: type: string description: type: string date: type: string format: date patient: $ref: '#/components/schemas/Association' practitioner: $ref: '#/components/schemas/Association' category: $ref: '#/components/schemas/Association' charge_item: $ref: '#/components/schemas/Association' location: $ref: '#/components/schemas/Association' required: - quantity - price_in_cents - name Provider.CustomerInvoices.ChargesController.create_body: type: object properties: quantity: type: number format: double price_in_cents: type: number format: double name: type: string description: type: string date: type: string format: date patient: $ref: '#/components/schemas/Association' practitioner: $ref: '#/components/schemas/Association' category: $ref: '#/components/schemas/Association' charge_item: $ref: '#/components/schemas/Association' location: $ref: '#/components/schemas/Association' required: - quantity - price_in_cents - name Association: type: object properties: id: type: string required: - id securitySchemes: BearerAuth: type: http scheme: bearer description: Practice access token or Partner API key (Bearer authentication)