HIhint
Membership

Confirm Membership

Changed on

Confirms an unconfirmed membership so it starts billing, and sends the patient the membership created email. Confirming an already confirmed membership is a no-op. Memberships synced from a network are read-only for the affiliate practice, with one exception: when the network requires affiliates to confirm memberships, the affiliate may update the unconfirmed synced copy and confirm it with this endpoint, and the network's record is confirmed along with it. Any other change to a synced membership returns 409 "Contact the network to change this membership".

post/provider/memberships/{id}/confirm

Request

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

Path parameters

idstring required

Unique Membership ID

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 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