GET api/Membership/GetProspectiveMembershipDetails?productId={productId}&userId={userId}&orgId={orgId}&invoiceFrequency={invoiceFrequency}&discountCode={discountCode}

Request Information

URI Parameters

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

Body Parameters

None.

Response Information

Resource Description

ProspectiveMembershipResponseModel

Name	Type	Additional information
ProductName	string	None.
StartDate	string	None.
EndDate	string	None.
ProductAmount	decimal number	None.
SetupFee	decimal number	None.
ProductAmountMonthly	decimal number	None.
ProductAmountMonthlyTotal	decimal number	None.
SetupFeeMonthly	decimal number	None.
TotalAmount	decimal number	None.
TotalAmountMonthly	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.
BaseInstalmentAmountString	string	None.
Result	ResponseResult	None.

Response Formats

application/json, text/json

Sample:

{
  "ProductName": "sample string 1",
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "ProductAmount": 1.0,
  "SetupFee": 1.0,
  "ProductAmountMonthly": 1.0,
  "ProductAmountMonthlyTotal": 1.0,
  "SetupFeeMonthly": 1.0,
  "TotalAmount": 4.0,
  "TotalAmountMonthly": 5.0,
  "ProRataAmount": 1.0,
  "ApplicationType": "sample string 6",
  "RenewalType": "sample string 7",
  "CurrentSubsOwing": 1.0,
  "CurrentSubsRebate": 1.0,
  "RebateToBeApplied": 1.0,
  "FinalAmountToBePaid": 1.0,
  "NextAmountToBePaid": 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"
    }
  ],
  "PaymentPlan": [
    {
      "Amount": 1.0,
      "PaymentDate": "2024-11-29T09:42:17.286002+11:00"
    },
    {
      "Amount": 1.0,
      "PaymentDate": "2024-11-29T09:42:17.286002+11:00"
    }
  ],
  "BaseInstalmentAmountString": "sample string 8",
  "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 6</ApplicationType>
  <BaseInstalmentAmountString>sample string 8</BaseInstalmentAmountString>
  <CurrentSubsOwing>1</CurrentSubsOwing>
  <CurrentSubsRebate>1</CurrentSubsRebate>
  <EndDate>sample string 3</EndDate>
  <FinalAmountToBePaid>1</FinalAmountToBePaid>
  <NextAmountToBePaid>1</NextAmountToBePaid>
  <PaymentPlan>
    <PaymentPlanResponseModel>
      <Amount>1</Amount>
      <PaymentDate>2024-11-29T09:42:17.286002+11:00</PaymentDate>
    </PaymentPlanResponseModel>
    <PaymentPlanResponseModel>
      <Amount>1</Amount>
      <PaymentDate>2024-11-29T09:42:17.286002+11:00</PaymentDate>
    </PaymentPlanResponseModel>
  </PaymentPlan>
  <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>
  <ProductAmount>1</ProductAmount>
  <ProductAmountMonthly>1</ProductAmountMonthly>
  <ProductAmountMonthlyTotal>1</ProductAmountMonthlyTotal>
  <ProductName>sample string 1</ProductName>
  <RebateToBeApplied>1</RebateToBeApplied>
  <RenewalType>sample string 7</RenewalType>
  <SetupFee>1</SetupFee>
  <SetupFeeMonthly>1</SetupFeeMonthly>
  <StartDate>sample string 2</StartDate>
  <TotalAmount>4</TotalAmount>
  <TotalAmountMonthly>5</TotalAmountMonthly>
</ProspectiveMembershipResponseModel>