HIhint
MembershipMember

Update Member

Changed on
patch/provider/memberships/{membership_id}/members/{id}

Request

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

Path parameters

membership_idstring required

Unique Membership ID

idstring required

Unique Membership Member ID

Request body

start_datestring date

Defaults to Membership start date if not given. Sponsored memberships must start on the 1st of the month. Retail memberships may start any day. Date must be formatted as YYYY-MM-DD.

member_type'child' | 'spouse' required

Choose one below. You can think of "spouse" as "adult". This is a naming issue that will hopefully be addressed in the future. Note: "employee" is not an accepted value as you cannot add employees to existing memberships.

fixed_period_rate_in_centsinteger

Use this to override the standard rates that the membership plan would generate

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 patient/patient_agreement_accepted deprecated

    • info

      response property patient/patient_agreement_accepted_at deprecated

    • info

      response property patient/terms_accepted deprecated

    • info

      response property patient/terms_accepted_at deprecated