HIhint
Membership

Create Membership

Changed on

Patients synced from a network cannot be enrolled by the affiliate practice: creating a membership for one returns 409 "This patient is synced from a Network". Contact the network to enroll them.

post/provider/memberships

Request

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

Request body

start_datestring date required

Sponsored memberships must start on the 1st of the month. Retail memberships may start any day. Date must be formatted as YYYY-MM-DD.

end_datestring date

Date must be formatted as YYYY-MM-DD.

period_in_monthsinteger required

Billing period in months. 1 = monthly, 3 = quarterly, 6 = semi-annually, 12 = annually

fixed_period_rate_in_centsinteger
fixed_registration_fee_in_centsinteger
is_confirmedboolean

Defaults to true. Send false to create the membership as unconfirmed: it is not billed and stays in the "unconfirmed" status until it is confirmed with the Confirm Membership endpoint. The patient is not emailed about an unconfirmed membership at creation; the membership created email is sent when it is confirmed. Practices in a network that requires affiliates to confirm memberships always create them unconfirmed, so the is_confirmed value in the response can differ from the value sent.

Response

Successful response

idstring
bill_datestring date
billed_through_datestring date
billing_start_datestring date
bills_at_end_of_periodboolean
cancellation_reason_otherstring

Free-text detail recorded with the cancellation. Only set when cancellation_reason is "Other" or "Termination by Patient" (the text the patient entered when ending their own membership); otherwise null.

contract_expiration_actionstring
contract_expiresstring date
contract_period_in_monthsinteger
created_atstring date-time
end_datestring date
enrollment_statusstring
fixed_period_rate_in_centsinteger
fixed_registration_fee_in_centsinteger
group_codestring
is_confirmedboolean
is_currentboolean
is_processingboolean
is_restartableboolean
list_price_in_centsinteger
next_bill_datestring date
period_in_monthsstring
period_rate_in_centsinteger
rate_in_centsinteger
source_statusstring
start_datestring date
statusstring
updated_atstring date-time

Changes

  • c9bda0d2dd87Revision changes
    • breaking

      the response's property type changed from string to boolean for status

    • info

      added the new optional request property

    • 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

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

    • info

      response property membership_patients/patient/patient_agreement_accepted_at deprecated

    • info

      response property membership_patients/patient/terms_accepted deprecated

    • info

      response property membership_patients/patient/terms_accepted_at deprecated

    • info

      response property owner/patient_agreement_accepted deprecated

    • info

      response property owner/patient_agreement_accepted_at deprecated

    • info

      response property owner/terms_accepted deprecated

    • info

      response property owner/terms_accepted_at deprecated