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

Returns freeze options for a membership and sservice

Request Parameters

From Body Type Description
Id Guid Contact Guid
FreezeOptionsMembershipRequest Optional. To get options for membership, at least pass in an empty object
Name Type Description
AgreementIds [Int32] Optional. List of agreements ids on which you want to apply the freeze. Leave empty if you do not know the AgreementIds yet
AllowReferralDiscount Boolean Optional. To Allow referral discounts while freeze is active
EndDate DateTime Optional. Leave empty if you do not know the EndDate yet
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 Optional. Leave empty if you do not know the Freeze Reason Id yet
FreezeTypeId Int32 Optional. Leave empty if you do not know the Freeze Type Id yet
OverridenCycleFee Decimal Optional. The cycle fee overriden by the user
StartDate DateTime Optional. Leave empty if you do not know the StartDate yet
[FreezeOptionsServiceRequest] Optional. List of the services on member account you want to freeze
Name Type Description
EndDate DateTime Optional.
FreezeReasonId Int32 Optional.
FreezeTypeId Int32 Optional.
ServiceId Int32 Optional.
StartDate DateTime Optional. 




{
  "Id": "7a3b17d0-5e4c-4812-951a-3d0bebd94761",
  "Membership": {
    "StartDate": "2025-04-25T14:24:00.938619+01:00",
    "EndDate": "2025-04-25T14:24:00.938619+01:00",
    "AgreementIds": [
      1,
      2,
      3
    ],
    "FreezeReasonId": 1,
    "FreezeTypeId": 1,
    "OverridenCycleFee": 1.0,
    "AllowReferralDiscount": true
  },
  "Services": [
    {
      "ServiceId": 1,
      "FreezeReasonId": 1,
      "FreezeTypeId": 1,
      "StartDate": "2025-04-25T14:24:00.9396177+01:00",
      "EndDate": "2025-04-25T14:24:00.9396177+01:00"
    },
    {
      "ServiceId": 1,
      "FreezeReasonId": 1,
      "FreezeTypeId": 1,
      "StartDate": "2025-04-25T14:24:00.9396177+01:00",
      "EndDate": "2025-04-25T14:24:00.9396177+01:00"
    },
    {
      "ServiceId": 1,
      "FreezeReasonId": 1,
      "FreezeTypeId": 1,
      "StartDate": "2025-04-25T14:24:00.9396177+01:00",
      "EndDate": "2025-04-25T14:24:00.9396177+01:00"
    }
  ]
}

Response - (Status 200 - OK)

FreezeOptionsResponse

Name Type Description
Id Guid
FreezeOptionsItemResponse
Name Type Description
CanFreeze Boolean
ErrorMessage String If there is value in this property, then it indicates an error and the item cannot be frozen.
ReferralDiscountsEnabled Boolean
WarningMessage String
[FreezeType]
Name Type Description
Id Int32
AdminFee Decimal
AllowFreezeCylceFeeOverride Boolean Indicates whether the user can override freeze cycle fee to the one configured in Legend
BillingCycle
Values
1 - Weekly
2 - BiWeekly
3 - FourWeekly
4 - Monthly
5 - Annual
6 - PaidInFull
7 - Quarterly
8 - HalfYearly
FreezeCycleFee Decimal Cyclce fee during the freeze
KeepExistingCycleFee Boolean Indicates whether existing cycle fee will be charged during the freeze. When 'True' ignore 'FreezeCycleFee' flag
MaxPeriod Int32 If zero, then no restriction
MinPeriod Int32 If zero, then no restriction
Name String
WillExtendRenewalDate Boolean
WillPreventDiscounts Boolean
WillPreventEntry Boolean
[FreezeForAgreement] If doing membership freeze, this will tell you how many agreements you can apply the freeze on.
Name Type Description
AgreementId Int32
Autobill Boolean
FirstName String
LastName String
LastUseDate DateTime
lgdAgreementLinkTypeID Int32
MemberId Int32
MemberNo String
refAgreementDesc String
refAgreementId Int32
StartDate DateTime
TerminationDate DateTime
[FreezeOptionsItemResponse]
Name Type Description
CanFreeze Boolean
ErrorMessage String If there is value in this property, then it indicates an error and the item cannot be frozen.
ServiceId Int32
WarningMessage String
[FreezeType]
Name Type Description
Id Int32
AdminFee Decimal
AllowFreezeCylceFeeOverride Boolean Indicates whether the user can override freeze cycle fee to the one configured in Legend
BillingCycle
Values
1 - Weekly
2 - BiWeekly
3 - FourWeekly
4 - Monthly
5 - Annual
6 - PaidInFull
7 - Quarterly
8 - HalfYearly
FreezeCycleFee Decimal Cyclce fee during the freeze
KeepExistingCycleFee Boolean Indicates whether existing cycle fee will be charged during the freeze. When 'True' ignore 'FreezeCycleFee' flag
MaxPeriod Int32 If zero, then no restriction
MinPeriod Int32 If zero, then no restriction
Name String
WillExtendRenewalDate Boolean
WillPreventDiscounts Boolean
WillPreventEntry Boolean 




{
  "Id": "9ae2c5bf-c055-4aac-b498-06ea3795f9b1",
  "MembershipOptions": {
    "FreezeTypes": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "WillPreventEntry": true,
        "WillPreventDiscounts": true,
        "WillExtendRenewalDate": true,
        "MinPeriod": 6,
        "MaxPeriod": 7,
        "BillingCycle": 1,
        "AdminFee": 8.0,
        "FreezeCycleFee": 9.0,
        "KeepExistingCycleFee": true,
        "AllowFreezeCylceFeeOverride": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "WillPreventEntry": true,
        "WillPreventDiscounts": true,
        "WillExtendRenewalDate": true,
        "MinPeriod": 6,
        "MaxPeriod": 7,
        "BillingCycle": 1,
        "AdminFee": 8.0,
        "FreezeCycleFee": 9.0,
        "KeepExistingCycleFee": true,
        "AllowFreezeCylceFeeOverride": true
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "WillPreventEntry": true,
        "WillPreventDiscounts": true,
        "WillExtendRenewalDate": true,
        "MinPeriod": 6,
        "MaxPeriod": 7,
        "BillingCycle": 1,
        "AdminFee": 8.0,
        "FreezeCycleFee": 9.0,
        "KeepExistingCycleFee": true,
        "AllowFreezeCylceFeeOverride": true
      }
    ],
    "FreezeValidOnAgreements": [
      {
        "AgreementId": 1,
        "MemberId": 2,
        "MemberNo": "sample string 3",
        "StartDate": "2025-04-25T14:24:00.9486614+01:00",
        "LastUseDate": "2025-04-25T14:24:00.9486614+01:00",
        "refAgreementId": 4,
        "refAgreementDesc": "sample string 5",
        "Autobill": true,
        "TerminationDate": "2025-04-25T14:24:00.9486614+01:00",
        "lgdAgreementLinkTypeID": 6,
        "FirstName": "sample string 7",
        "LastName": "sample string 8"
      },
      {
        "AgreementId": 1,
        "MemberId": 2,
        "MemberNo": "sample string 3",
        "StartDate": "2025-04-25T14:24:00.9486614+01:00",
        "LastUseDate": "2025-04-25T14:24:00.9486614+01:00",
        "refAgreementId": 4,
        "refAgreementDesc": "sample string 5",
        "Autobill": true,
        "TerminationDate": "2025-04-25T14:24:00.9486614+01:00",
        "lgdAgreementLinkTypeID": 6,
        "FirstName": "sample string 7",
        "LastName": "sample string 8"
      },
      {
        "AgreementId": 1,
        "MemberId": 2,
        "MemberNo": "sample string 3",
        "StartDate": "2025-04-25T14:24:00.9486614+01:00",
        "LastUseDate": "2025-04-25T14:24:00.9486614+01:00",
        "refAgreementId": 4,
        "refAgreementDesc": "sample string 5",
        "Autobill": true,
        "TerminationDate": "2025-04-25T14:24:00.9486614+01:00",
        "lgdAgreementLinkTypeID": 6,
        "FirstName": "sample string 7",
        "LastName": "sample string 8"
      }
    ],
    "ErrorMessage": "sample string 1",
    "WarningMessage": "sample string 2",
    "CanFreeze": false,
    "ReferralDiscountsEnabled": true
  },
  "ServiceOptions": [
    {
      "ServiceId": 1,
      "FreezeTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        }
      ],
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3",
      "CanFreeze": false
    },
    {
      "ServiceId": 1,
      "FreezeTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        }
      ],
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3",
      "CanFreeze": false
    },
    {
      "ServiceId": 1,
      "FreezeTypes": [
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        },
        {
          "Id": 1,
          "Name": "sample string 2",
          "WillPreventEntry": true,
          "WillPreventDiscounts": true,
          "WillExtendRenewalDate": true,
          "MinPeriod": 6,
          "MaxPeriod": 7,
          "BillingCycle": 1,
          "AdminFee": 8.0,
          "FreezeCycleFee": 9.0,
          "KeepExistingCycleFee": true,
          "AllowFreezeCylceFeeOverride": true
        }
      ],
      "ErrorMessage": "sample string 2",
      "WarningMessage": "sample string 3",
      "CanFreeze": false
    }
  ]
}

Remarks

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

Bundle(s)
Freeze