v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Freeze the membership of a guest

This API helps you to freeze the membership of a guest.

You must specify appropriate details for the guest_id and membership_id parameters in the API request.

Optionally, you can specify the necessary details for the start_date, end_date, fee, type, and changed_unfreeze_date parameters in the API request body.

put/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze

Path parameters

guest_idstring required

Mandatory Unique 32-character identifier of the guest.

user_membership_idstring required

Mandatory Unique 32-character identifier of the guest's membership.

Request body

start_datestring date

Beginning date of the membership freeze.

end_datestring date

Ending date of the membership freeze.

feeinteger

This is the freeze fee on the membership charged to the guest.

type'2' | '3'

Type of membership freeze process. Indicates one of the following: 2 - Freeze benefits and shift next payment date by freeze period. 3 - Allow guest to use benefits and skip payments in freeze period. Note: You can only specify the value of this parameter as either 2 or 3.

changed_unfreeze_datestring date

Date that replaces the previous end_date value of the guest membership. In other words, changed_unfreeze_date is the new date until which the guest's membership is to be frozen. Format: YYYY-MM-DD.

Response

200

Example response

{
  "error": {
    "code": 502,
    "message": "Freeze Fee cannot be less than 0$"
  }
}