HIhint
Membership

Cancel Membership

Changed on
post/provider/memberships/{id}/cancel

Request

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

Path parameters

idstring required

Unique Membership ID

Request body

end_datestring date required

It must line up with the membership's bill_date (not next_bill_date). Eg. A membership that bills on the 5th must end on the 5th. Date must be formatted as YYYY-MM-DD.

cancellation_reason_otherstring

Description required when sending cancellation_reason of "Other"

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