API Reference

List Coupons

Hero Health Public API (1.0.0)

Download OpenAPI description

Download API docs

Servers

Mock server

https://developer.herohealth.net/_mock/apis/public-api/openapi/

Staging

https://api.staging.htech.app/

Production

https://api.herohealth.net/

Practice Group

Operations

Admin

Operations

Booking

Operations

Links

Operations

Utilities

Operations

Messages

Operations

Form

Operations

Form Response

Operations

Invoicing

Operations

List Coupons

Request

Retrieves a list of Stripe coupons for the requesting practice group.

curl -i -X GET \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/coupons \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objectsrequired

data[].idstringrequired

data[].namestringrequired

data[].applies_toobject

data[].amount_offnumber

data[].percent_offnumber

countnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "count": 0
}

List Customers

Request

Retrieves a list of Stripe customers for the requesting practice group.

Query

querystringrequired

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/customers?query=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objectsrequired

data[].idstringrequired

data[].namestringrequired

data[].emailstring(email)

data[].phonestring

data[].sourcesArray of objects or objects

countnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "count": 0
}

Create Customer

Request

Creates a new Stripe customer for the requesting practice group.

Bodyapplication/jsonrequired

namestringrequired

emailstring(email)

phonestring

sourcesArray of objects or objects

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/customers \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "email": "user@example.com",
    "phone": "string",
    "sources": [
      {
        "id": "string",
        "type": "card",
        "fingerprint": "string",
        "brand": "string",
        "last4": "string",
        "exp_month": 0,
        "exp_year": 0
      }
    ]
  }'

Responses

Bodyapplication/json

idstringrequired

namestringrequired

emailstring(email)

phonestring

sourcesArray of objects or objects

Response

application/json

{
  "id": "string",
  "name": "string",
  "email": "user@example.com",
  "phone": "string",
  "sources": [
    { … }
  ]
}

Create Membership Policy

Request

Creates a new membership policy for the requesting practice group.

Bodyapplication/jsonrequired

One of:

collection_methodstringrequired

Value"charge_automatically"

payment_methodstringrequired

membership_scheme_idstringnon-emptyrequired

customerstringrequired

pricestringrequired

quantitynumberrequired

starts_onnumberrequired

billing_cycle_anchornumberrequired

discountsArray of objectsrequired

discounts[].couponstringrequired

membersArray of objectsrequired

members[].patient_record_idstringrequired

curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/membership-policies \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "collection_method": "send_invoice",
    "days_until_due": 0,
    "membership_scheme_id": "string",
    "customer": "string",
    "price": "string",
    "quantity": 0,
    "starts_on": 0,
    "billing_cycle_anchor": 0,
    "discounts": [
      {
        "coupon": "string"
      }
    ],
    "members": [
      {
        "patient_record_id": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

idstring or null

practice_group_idstring or null

membership_scheme_idstring or null

Response

application/json

{
  "id": "string",
  "practice_group_id": "string",
  "membership_scheme_id": "string"
}

List Membership Schemes

Request

Retrieves a list of membership schemes for the requesting practice group.

curl -i -X GET \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/membership-schemes \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objectsrequired

data[].idstring or null

data[].namestringrequired

data[].lengthstringrequired

Enum"yearly""monthly"

data[].productobjectrequired

data[].product.idstringrequired

data[].product.namestringrequired

data[].product.descriptionstring

data[].product.codestring

data[].product.categorystring

data[].product.default_priceobject

data[].product.pricesArray of objectsrequired

data[].product.prices[].idstringrequired

data[].product.prices[].unit_amountnumberrequired

data[].product.prices[].nicknamestring

data[].product.prices[].recurringobjectrequired

data[].product.prices[].recurring.intervalstringrequired

Enum"day""week""month""year"

data[].product.prices[].recurring.interval_countnumberrequired

countnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "count": 0
}

List Products

Request

Retrieves a list of Stripe products for the requesting practice group.

Query

querystringrequired

activeboolean

typestring

curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/invoicing/products?active=true&query=string&type=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

dataArray of objectsrequired

data[].idstringrequired

data[].namestringrequired

data[].descriptionstring

data[].codestring

data[].categorystring

data[].default_priceobject

data[].pricesArray of objectsrequired

data[].prices[].idstringrequired

data[].prices[].unit_amountnumberrequired

data[].prices[].nicknamestring

data[].prices[].recurringobjectrequired

data[].prices[].recurring.intervalstringrequired

Enum"day""week""month""year"

data[].prices[].recurring.interval_countnumberrequired

countnumberrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "count": 0
}

Patients

Operations

Prescription

Operations

Task

Operations

Webhooks

Operations

Prescriptions

Operations

Hero Health Public API (1.0.0)

Practice Group

Admin

Booking

Links

Utilities

Messages

Care Navigation

Form

Form Response

Invoicing

List Coupons

Request

Responses

Was this helpful?

List Customers

Request

Responses

Was this helpful?

Create Customer

Request

Responses

Was this helpful?

Create Membership Policy

Request

Responses

Was this helpful?

List Membership Schemes

Request

Responses

Was this helpful?

List Products

Request

Responses

Was this helpful?

Patients

Prescription

Task

Webhooks

Prescriptions

Hero Health Public API (1.0.0)

Practice Group

Admin

Booking

Links

Utilities

Messages

Care Navigation

Form

Form Response

Invoicing

List Coupons

Request

Responses

Was this helpful?

List Customers

Request

Responses

Was this helpful?

Create Customer

RequestExpand all

Responses

Was this helpful?

Create Membership Policy

Request

Responses

Was this helpful?

List Membership Schemes

Request

Responses

Was this helpful?

List Products

Request

Responses

Was this helpful?

Patients

Prescription

Task

Webhooks

Prescriptions

Request