Skip to content
API reference/
/Memberships

Memberships

Manage notification subscriptions, subscribers, membership policies, and membership schemes.

Operations

Create Membership Policy

Request

Creates a new membership policy for the requesting practice group.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
One of:
membership_scheme_idstring, non-emptyrequired
customerstringrequired
pricestringrequired
quantitynumberrequired
starts_onnumberrequired
billing_cycle_anchornumberrequired
discountsArray of objectsrequired
membersArray of objectsrequired
collection_methodstringrequired
Value:"charge_automatically"
payment_methodstringrequired
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": "charge_automatically",
    "payment_method": "string",
    "membership_scheme_id": "string",
    "customer": "string",
    "price": "string",
    "quantity": 0,
    "starts_on": 0,
    "billing_cycle_anchor": 0,
    "discounts": [
      {
        "coupon": "string"
      }
    ],
    "members": [
      {
        "patient_id": "string"
      }
    ]
  }'

Responses

Ok

Bodyapplication/json
idstring or null
practice_group_idstring or null
membership_scheme_idstring or null
Response
{
  "id": "string",
  "practice_group_id": "string",
  "membership_scheme_id": "string"
}