POST https://api.legendonlineservices.co.uk/Joining/Freeze

Returns freeze options for a membership/service

Request Parameters

From Body Type Description
Id Guid Contact Guid
FreezeServiceRequest Optional.
Name Type Description
AgreementIds [Int32] List of member agreements to apply freeze on. See FreezeOptions
AllowReferralDiscount Boolean Optional. To Allow referral discounts while freeze is active
EndDate DateTime This should be one day less than the actual freeze date. e.g, if you want the freeze to finish on 10th, send 9th as the end date
FreezeReasonId Int32
FreezeTypeId Int32 See FreezeOptions
OverridenCycleFee Decimal Optional. The cycle fee overriden by the user
StartDate DateTime
[FreezeServiceRequest] Optional.
Name Type Description
EndDate DateTime Optional. This should be one day less than the actual freeze date. e.g, if you want the freeze to finish on 10th, send 9th as the end date
FreezeReasonId Int32
FreezeTypeId Int32 See FreezeOptions
ServiceId Int32
StartDate DateTime 




{
  "Id": "64091cd7-5260-4c7d-92c2-ba9b07539554",
  "Membership": {
    "StartDate": "2025-06-11T08:06:50.1384366+01:00",
    "EndDate": "2025-06-11T08:06:50.1384366+01:00",
    "AgreementIds": [
      1,
      2,
      3
    ],
    "FreezeReasonId": 1,
    "FreezeTypeId": 2,
    "OverridenCycleFee": 1.0,
    "AllowReferralDiscount": true
  },
  "Services": [
    {
      "ServiceId": 1,
      "StartDate": "2025-06-11T08:06:50.1384366+01:00",
      "EndDate": "2025-06-11T08:06:50.1384366+01:00",
      "FreezeReasonId": 2,
      "FreezeTypeId": 3
    },
    {
      "ServiceId": 1,
      "StartDate": "2025-06-11T08:06:50.1384366+01:00",
      "EndDate": "2025-06-11T08:06:50.1384366+01:00",
      "FreezeReasonId": 2,
      "FreezeTypeId": 3
    },
    {
      "ServiceId": 1,
      "StartDate": "2025-06-11T08:06:50.1384366+01:00",
      "EndDate": "2025-06-11T08:06:50.1384366+01:00",
      "FreezeReasonId": 2,
      "FreezeTypeId": 3
    }
  ]
}

Response - (Status 200 - OK)

FreezeResponse

Name Type Description
Id Guid
ErrorMessage String
Success Boolean
FreezeMembershipResponse
Name Type Description
ErrorMessage String If there is value in this property, then it indicates an error and the freeze failed
MemberFreezeId Int32
WarningMessage String
[FreezeBillingResponse] Charge Ids generated by Legend during the freeze
Name Type Description
Balance Decimal
BillingId Int32
[FreezeServiceResponse]
Name Type Description
ErrorMessage String If there is value in this property, then it indicates an error and the freeze failed
ServiceFreezeId Int32
ServiceId Int32
WarningMessage String 




{
  "Id": "8d586d09-62a2-440b-81c5-e130a48371d2",
  "Membership": {
    "Billings": [
      {
        "BillingId": 1,
        "Balance": 2.0
      },
      {
        "BillingId": 1,
        "Balance": 2.0
      },
      {
        "BillingId": 1,
        "Balance": 2.0
      }
    ],
    "MemberFreezeId": 1,
    "ErrorMessage": "sample string 1",
    "WarningMessage": "sample string 2"
  },
  "Services": [
    {
      "ServiceId": 1,
      "ServiceFreezeId": 1,
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3"
    },
    {
      "ServiceId": 1,
      "ServiceFreezeId": 1,
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3"
    },
    {
      "ServiceId": 1,
      "ServiceFreezeId": 1,
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3"
    }
  ],
  "ErrorMessage": "sample string 2",
  "Success": false
}

Remarks

Only contact services can be frozen. CAP2, Sports Courses not supported

Bundle(s)
Freeze