GET api/Membership/GetProspectiveMembershipPriceDiscountDetails?userId={userId}&productId={productId}&memberDefinedDiscount={memberDefinedDiscount}&adminDefinedDiscount={adminDefinedDiscount}&spouseMemberNumber={spouseMemberNumber}&discountCode={discountCode}

Request Information

URI Parameters

Name	Type	Additional information
userId	string	Required
productId	string	Required
memberDefinedDiscount	string	Default value is
adminDefinedDiscount	string	Default value is
spouseMemberNumber	string	Default value is
discountCode	string	Default value is

Body Parameters

None.

Response Information

Resource Description

ProspectiveMembershipPriceDiscountResponseModel

Name	Type	Additional information
ProductId	globally unique identifier	None.
ProductName	string	None.
AsOfDate	date	None.
TotalAmount	decimal number	None.
AmountToCharge	decimal number	None.
DiscountAmount	decimal number	None.
FinalAmountBeforeDiscount	decimal number	None.
ProRataAmount	decimal number	None.
NextAmountToBePaid	decimal number	None.
FinalAmountToBePaid	decimal number	None.
PriceBreakdown	Collection of PriceResponseModel	None.
MembershipBreakdown	Collection of KeyValuePairResponseModel	None.
DiscountBreakdown	Collection of KeyValuePairResponseModel	None.
Result	ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "ProductId": "2859ee45-7449-45ac-a3e2-232e89def192",
  "ProductName": "sample string 2",
  "AsOfDate": "2024-11-29T09:33:54.1295486+11:00",
  "TotalAmount": 4.0,
  "AmountToCharge": 5.0,
  "DiscountAmount": 6.0,
  "FinalAmountBeforeDiscount": 1.0,
  "ProRataAmount": 1.0,
  "NextAmountToBePaid": 1.0,
  "FinalAmountToBePaid": 1.0,
  "PriceBreakdown": [
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Id": "sample string 3"
    },
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Id": "sample string 3"
    }
  ],
  "MembershipBreakdown": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "FieldType": "sample string 3",
      "Label": "sample string 4",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "FieldType": "sample string 3",
      "Label": "sample string 4",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    }
  ],
  "DiscountBreakdown": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "FieldType": "sample string 3",
      "Label": "sample string 4",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2",
      "FieldType": "sample string 3",
      "Label": "sample string 4",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    }
  ],
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ProspectiveMembershipPriceDiscountResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bond.Core.API.Models.Response">
  <Result>
    <Errors>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
      <ErrorMessage>
        <Message>sample string 1</Message>
      </ErrorMessage>
    </Errors>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </Result>
  <AmountToCharge>5</AmountToCharge>
  <AsOfDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-28T22:33:54.1295486Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
  </AsOfDate>
  <DiscountAmount>6</DiscountAmount>
  <DiscountBreakdown>
    <KeyValuePairResponseModel>
      <Result>
        <Errors>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
        </Errors>
        <Message>sample string 2</Message>
        <Success>true</Success>
      </Result>
      <FieldType>sample string 3</FieldType>
      <Key>sample string 1</Key>
      <Label>sample string 4</Label>
      <Value>sample string 2</Value>
    </KeyValuePairResponseModel>
    <KeyValuePairResponseModel>
      <Result>
        <Errors>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
        </Errors>
        <Message>sample string 2</Message>
        <Success>true</Success>
      </Result>
      <FieldType>sample string 3</FieldType>
      <Key>sample string 1</Key>
      <Label>sample string 4</Label>
      <Value>sample string 2</Value>
    </KeyValuePairResponseModel>
  </DiscountBreakdown>
  <FinalAmountBeforeDiscount>1</FinalAmountBeforeDiscount>
  <FinalAmountToBePaid>1</FinalAmountToBePaid>
  <MembershipBreakdown>
    <KeyValuePairResponseModel>
      <Result>
        <Errors>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
        </Errors>
        <Message>sample string 2</Message>
        <Success>true</Success>
      </Result>
      <FieldType>sample string 3</FieldType>
      <Key>sample string 1</Key>
      <Label>sample string 4</Label>
      <Value>sample string 2</Value>
    </KeyValuePairResponseModel>
    <KeyValuePairResponseModel>
      <Result>
        <Errors>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
          <ErrorMessage>
            <Message>sample string 1</Message>
          </ErrorMessage>
        </Errors>
        <Message>sample string 2</Message>
        <Success>true</Success>
      </Result>
      <FieldType>sample string 3</FieldType>
      <Key>sample string 1</Key>
      <Label>sample string 4</Label>
      <Value>sample string 2</Value>
    </KeyValuePairResponseModel>
  </MembershipBreakdown>
  <NextAmountToBePaid>1</NextAmountToBePaid>
  <PriceBreakdown>
    <PriceResponseModel>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
      <Id>sample string 3</Id>
    </PriceResponseModel>
    <PriceResponseModel>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
      <Id>sample string 3</Id>
    </PriceResponseModel>
  </PriceBreakdown>
  <ProRataAmount>1</ProRataAmount>
  <ProductId>2859ee45-7449-45ac-a3e2-232e89def192</ProductId>
  <ProductName>sample string 2</ProductName>
  <TotalAmount>4</TotalAmount>
</ProspectiveMembershipPriceDiscountResponseModel>