---
title: "Freeze the membership of a guest"
method: PUT
path: "/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze"
---

# Freeze the membership of a guest

`PUT /v1/guests/{guest_id}/memberships/{user_membership_id}/freeze`

## Request

- Base URL: `https://api.zenoti.com`
- URL: `https://api.zenoti.com/v1/guests/{guest_id}/memberships/{user_membership_id}/freeze`
- Auth: none required

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.

## Path parameters

- `guest_id` string, required
- `user_membership_id` string, required

## Request body

- object
  - `start_date` string, date: Beginning date of the membership freeze.
  - `end_date` string, date: Ending date of the membership freeze.
  - `fee` integer: 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_date` string, 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`

200

- object
  - `error` object
    - `code` integer
    - `message` string

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/zenoti/apis/zenoti-authentication.md) - [All operations](https://skmtc.dev/zenoti/apis/zenoti-authentication/llms.txt) - [OpenAPI document](https://skmtc.dev/zenoti/apis/zenoti-authentication/revisions/e628f892391a?raw)