Freeze Membership

POST /membership/freeze

Bearer auth

Freeze membership by given id. You can only freeze/unfreeze your own memberships.

application/json

Body Required

membership_id number

Id of the appointment in database (retrieved using GET /membership/active)

Responses

200 application/json

Successful freezing of a membership.
Hide response attributes Show response attributes object
- success boolean
  
  Whether membership was freezed
- freeze object
  
  Additional properties are allowed.
  
  Hide freeze attributes Show freeze attributes object
  
  membership_id integer Required
  
  Id of the membership in database
  
  client_id integer Required
  
  Id of the client in database
  
  level_type string Required
  
  Membership level
  
  Values are SIMPLE, INFINITY, or PREMIUM.
  
  freezed_at string(date) Required
  
  Membership freeze date
  
  created_at string(date) Required
  
  Membership creation date
  
  expires_at string(date) Required
  
  Membership expiry date
400 application/json

Validation error of given input.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error array[object]
  
  Validation error of given input.
  
  Hide error attributes Show error attributes object
  
  code string
  
  Error type
  
  expected string
  
  What was expected
  
  received string
  
  What's the error
  
  path array[string]
  
  What caused an error
  
  message string
  
  Error description
401 application/json

User is not unauthorized or permissions are missing.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error string
  
  Error message
404 application/json

Nothing found with given input.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error string
  
  Error message
429 application/json

Rate limit exceeded - 100 queries per 15 minutes.
Hide response attributes Show response attributes object
- success boolean
  
  Whether query is successful
- error string
  
  Error message

POST /membership/freeze

curl \
 --request POST 'http://63.141.232.244:25540/v0/membership/freeze' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"membership_id":1}'

Request examples

{
  "membership_id": 1
}

Response examples (200)

{
  "success": true,
  "freeze": {
    "client_id": 1,
    "created_at": "2024-10-10T18:36:47Z",
    "expires_at": "2024-11-10T18:36:47Z",
    "freezed_at": null,
    "level_type": "SIMPLE",
    "membership_id": 1
  }
}

Response examples (400)

{
  "success": false,
  "error": [
    {
      "code": "invalid_type",
      "expected": "string",
      "received": "undefined",
      "path": [
        "client_id"
      ],
      "message": "Required"
    }
  ]
}

Response examples (401)

{
  "success": false,
  "error": "Unauthorized"
}

Response examples (404)

{
  "success": false,
  "error": "Not found"
}

Response examples (429)

{
  "success": false,
  "error": "Too many requests, please try again later"
}