Skip to content

Freeze membership

Request

Freezes a subscription (membership) until the specified date.

The subscription's expiration date will be extended by the freeze period. Frozen subscriptions cannot be used for appointments.

Requirements:

  • Membership type must have allow_freeze: true
  • Freeze period must not exceed freeze_limit from membership type

Note: Requires chain-level permissions.

Security
BearerPartnerUser
Path
chain_idintegerrequired

Chain ID

Example:706028
membership_idintegerrequired

Membership ID to freeze

Example:123
Headers
Acceptstringrequired
Default:"application/vnd.api.v2+json"
Content-Typestringrequired
Default:"application/json"
Authorizationstringrequired

Bearer {partner_token}, User {user_token}

Bodyapplication/jsonrequired
freeze_tillstring, (date-time)required

Date until which the membership will be frozen (ISO 8601 format)

Example:"2026-12-31T23:59:59-05:00"
curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/chains/706028/loyalty/abonements/123/freeze \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "freeze_till": "2026-12-31T23:59:59-05:00"
  }'

Responses

Subscription frozen successfully

Bodyapplication/json
successboolean
Example:true
dataobject
metaArray of any
Example:
[]
Response
{ "success": true, "data": { "id": 123, "number": "123456", "is_frozen": true, "freeze_period": 14, "freeze_till": "2026-12-31T23:59:59-05:00" }, "meta": [] }