Patient Subscriptions

Get All Subscriptions

Note: This endpoint requires a compatible merchant services integration to be activated on the account. Accounts without an active merchant services integration will receive a 403 Forbidden response.

Please note: All dates listed (creation times, date taken) are listed in UTC, so you'll want to adjust for your local timezone.

get/patients/subscriptions

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/patients/subscriptions
  • Auth: HTTP basic

Query parameters

limitinteger

Number of results returned. Default (and maximum) is 100.

offsetinteger

Used for looping through the dataset. Default is 0.

include_deletedboolean

Returns deleted and current subscriptions if set to true. Default is false.

schedule_frequency'monthly' | 'weekly' | 'annually'

If set to monthly/weekly/annually, it will only return subscriptions billing at that frequency.

subscription_charge_idstring

ID of a specific charge associated with a subscription-type. If set, it will only return that type of subscription.

charge_owner_user_idstring

ID of a Cerbo user that gets 'credit' for that subscription. If set, it will only return 'their' subscriptions.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.