GET api/Membership/GetProspectiveMembershipDetails?userId={userId}&productId={productId}&invoiceFrequency={invoiceFrequency}&voucherstring={voucherstring}&workflowId={workflowId}

Request Information

URI Parameters

Name	Type	Additional information
userId	string	Required
productId	globally unique identifier	Required
invoiceFrequency	InvoiceFrequencyTypeEnum	Default value is Annual
voucherstring	string	None.
workflowId	string	None.

Body Parameters

None.

Response Information

Resource Description

ProspectiveMembershipResponseModel

Name	Type	Additional information
ProductName	string	None.
StartDate	date	None.
EndDate	date	None.
ProductAmount	decimal number	None.
SetupFee	decimal number	None.
InstalmentFee	decimal number	None.
TotalAmount	decimal number	None.
ProRataAmount	decimal number	None.
ApplicationType	string	None.
RenewalType	string	None.
CurrentSubsOwing	decimal number	None.
CurrentSubsRebate	decimal number	None.
RebateToBeApplied	decimal number	None.
FinalAmountToBePaid	decimal number	None.
NextAmountToBePaid	decimal number	None.
PriceBreakdown	Collection of PriceResponseModel	None.
PaymentPlan	Collection of PaymentPlanResponseModel	None.
Result	ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "ProductName": "sample string 1",
  "StartDate": "2024-11-29T09:47:15.7895297+11:00",
  "EndDate": "2024-11-29T09:47:15.7905305+11:00",
  "ProductAmount": 1.0,
  "SetupFee": 1.0,
  "InstalmentFee": 1.0,
  "TotalAmount": 2.0,
  "ProRataAmount": 1.0,
  "ApplicationType": "sample string 3",
  "RenewalType": "sample string 4",
  "CurrentSubsOwing": 1.0,
  "CurrentSubsRebate": 1.0,
  "RebateToBeApplied": 1.0,
  "FinalAmountToBePaid": 1.0,
  "NextAmountToBePaid": 1.0,
  "PriceBreakdown": [
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    },
    {
      "Amount": 1.0,
      "FeeType": "sample string 2",
      "Result": {
        "Success": true,
        "Message": "sample string 2",
        "Errors": [
          {
            "Message": "sample string 1"
          },
          {
            "Message": "sample string 1"
          }
        ]
      }
    }
  ],
  "PaymentPlan": [
    {
      "Amount": 1.0,
      "PaymentDate": "2024-11-29T09:47:15.7905305+11:00"
    },
    {
      "Amount": 1.0,
      "PaymentDate": "2024-11-29T09:47:15.7905305+11:00"
    }
  ],
  "Result": {
    "Success": true,
    "Message": "sample string 2",
    "Errors": [
      {
        "Message": "sample string 1"
      },
      {
        "Message": "sample string 1"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ProspectiveMembershipResponseModel 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>
  <ApplicationType>sample string 3</ApplicationType>
  <CurrentSubsOwing>1</CurrentSubsOwing>
  <CurrentSubsRebate>1</CurrentSubsRebate>
  <EndDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-28T22:47:15.7905305Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
  </EndDate>
  <FinalAmountToBePaid>1</FinalAmountToBePaid>
  <InstalmentFee>1</InstalmentFee>
  <NextAmountToBePaid>1</NextAmountToBePaid>
  <PaymentPlan>
    <PaymentPlanResponseModel>
      <Amount>1</Amount>
      <PaymentDate>2024-11-29T09:47:15.7905305+11:00</PaymentDate>
    </PaymentPlanResponseModel>
    <PaymentPlanResponseModel>
      <Amount>1</Amount>
      <PaymentDate>2024-11-29T09:47:15.7905305+11:00</PaymentDate>
    </PaymentPlanResponseModel>
  </PaymentPlan>
  <PriceBreakdown>
    <PriceResponseModel>
      <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>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
    </PriceResponseModel>
    <PriceResponseModel>
      <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>
      <Amount>1</Amount>
      <FeeType>sample string 2</FeeType>
    </PriceResponseModel>
  </PriceBreakdown>
  <ProRataAmount>1</ProRataAmount>
  <ProductAmount>1</ProductAmount>
  <ProductName>sample string 1</ProductName>
  <RebateToBeApplied>1</RebateToBeApplied>
  <RenewalType>sample string 4</RenewalType>
  <SetupFee>1</SetupFee>
  <StartDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-11-28T22:47:15.7895297Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>660</d2p1:OffsetMinutes>
  </StartDate>
  <TotalAmount>2</TotalAmount>
</ProspectiveMembershipResponseModel>