HIhint
MembershipMember

List All MembershipMembers

Changed on
get/provider/memberships/{membership_id}/members

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/memberships/{membership_id}/members
  • Auth
    API key in header AUTHORIZATION

Path parameters

membership_idstring required

Unique Membership ID

Response

Successful response

idstring
cancellation_reason_otherstring

Free-text detail for cancellation_reason, taken from the same record: the member's own removal when they were removed individually, otherwise the membership's cancellation. Only set when that reason is "Other" or "Termination by Patient"; otherwise null.

end_datestring
enrollment_requested_onstring date
enrollment_statusstring
fixed_period_rate_in_centsinteger
list_price_in_centsinteger
member_typestring
period_rate_in_centsinteger
revenue_in_centsinteger
start_datestring date
statusstring
uses_tobaccoboolean

Changes

  • c9bda0d2dd87Revision changes
    • 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 items/patient/patient_agreement_accepted deprecated

    • info

      response property items/patient/patient_agreement_accepted_at deprecated

    • info

      response property items/patient/terms_accepted deprecated

    • info

      response property items/patient/terms_accepted_at deprecated