RHP_API

GetMembershipOptions

Get all membership products for the current user.

The following routes are available for this service:
GET	/Product/Membership

**MembershipOptions** Parameters:
Name	Parameter	Data Type	Required	Description
Products	form	List<MembershipProduct>	No
PaymentOptions	form	PaymentProvider[]	No
DefaultPaymentProvider	form	PaymentProvider	No
AdditionalPaymentOptions	form	AdditionalPaymentOptions	No
VerotelPaymentOptions	form	VerotelPaymentOptions	No
IsPaymentAvailable	form	bool	No
ReturnCode	form	string	No
Message	form	string	No
UserDiscount	form	MembershipDiscountType	No
UserDiscountDetail	form	UserDiscountDetail	No
Currency	form	CurrencyDetail	No
PurchaseToken	form	string	No
UpgradePath	form	UpgradePath	No
IsStoredCardAvailable	form	bool	No
NonSubscriptionProducts	form	List<PurchaseProduct>	No	DEPRECATED - CoversationCredits has been moved to ConversationCredits property.
AddCreditCardProductToken	form	string	No
ConversationCredits	form	List<PurchaseProduct>	No
StoreCredits	form	List<PurchaseProduct>	No
ProductOptions	form	List<ProductOptions>	No

**MembershipProduct** Parameters:
Name	Parameter	Data Type	Required
Cost	form	List<MembershipProductCostDuration>	No
Name	form	string	No
Alias	form	string	No
MemberLevel	form	MemberLevelType	No
MemberLevelValue	form	int	No
CanBePurchased	form	bool	No

**MembershipProductCostDuration** Parameters:
Name	Parameter	Data Type	Required
Token	form	string	No
Duration	form	MembershipProductDuration	No
Cost	form	MembershipProductCost	No
VerotelSiteCode	form	string	No
ProductID	form	string	No
ProductIDAndroid	form	string	No

**MembershipProductDuration** Parameters:
Name	Parameter	Data Type	Required	Description
DurationType	form	MembershipDurationType	No
Length	form	int	No

**MembershipProductCost** Parameters:
Name	Parameter	Data Type	Required
FullPrice	form	decimal	No
Price	form	decimal	No
MonthlyPrice	form	decimal	No
DiscountType	form	MembershipDiscountType	No
SiteCode	form	string	No

**AdditionalPaymentOptions** Parameters:
Name	Parameter	Data Type	Required
BankTransfer	form	PaymentBankTransfer	No
BPay	form	PaymentBPay	No
Cheque	form	PaymentCheque	No
CompanyDetails	form	PaymentCompanyDetails	No
PayID	form	PaymentPayID	No

**PaymentBankTransfer** Parameters:
Name	Parameter	Data Type	Required
AccountName	form	string	No
BSB	form	string	No
AccountNumber	form	string	No
Reference	form	string	No

**PaymentBPay** Parameters:
Name	Parameter	Data Type	Required	Description
BillerCode	form	int	No
Reference	form	string	No

**PaymentCheque** Parameters:
Name	Parameter	Data Type	Required
AccountName	form	string	No
Address	form	string	No
Reference	form	string	No

**PaymentCompanyDetails** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Address	form	string	No

**PaymentPayID** Parameters:
Name	Parameter	Data Type	Required	Description
Number	form	string	No
Reference	form	string	No

**VerotelPaymentOptions** Parameters:
Name	Parameter	Data Type	Required	Description
Link	form	string	No
Username	form	string	No

**UserDiscountDetail** Parameters:
Name	Parameter	Data Type	Required	Description
Percentage	form	int	No

**CurrencyDetail** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Symbol	form	string	No
Code	form	string	No
CurrencyID	form	int	No

**PurchaseProduct** Parameters:
Name	Parameter	Data Type	Required
Cost	form	ProductCost	No
Token	form	string	No
Name	form	string	No
CanBePurchased	form	bool	No
Type	form	string	No
AppleProduct	form	string	No
PaymentIcon	form	string	No

**ProductCost** Parameters:
Name	Parameter	Data Type	Required	Description
Price	form	decimal	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Product/Membership HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MembershipOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RHP_API.ServiceModel">
  <AddCreditCardProductToken>String</AddCreditCardProductToken>
  <AdditionalPaymentOptions>
    <BPay>
      <BillerCode>0</BillerCode>
      <Reference>String</Reference>
    </BPay>
    <BankTransfer>
      <AccountName>String</AccountName>
      <AccountNumber>String</AccountNumber>
      <BSB>String</BSB>
      <Reference>String</Reference>
    </BankTransfer>
    <Cheque>
      <AccountName>String</AccountName>
      <Address>String</Address>
      <Reference>String</Reference>
    </Cheque>
    <CompanyDetails>
      <Address>String</Address>
      <Name>String</Name>
    </CompanyDetails>
    <PayID>
      <Number>String</Number>
      <Reference>String</Reference>
    </PayID>
  </AdditionalPaymentOptions>
  <ConversationCredits>
    <PurchaseProduct>
      <AppleProduct>String</AppleProduct>
      <CanBePurchased>false</CanBePurchased>
      <Cost>
        <Price>0</Price>
      </Cost>
      <Name>String</Name>
      <PaymentIcon>String</PaymentIcon>
      <Token>String</Token>
      <Type>String</Type>
    </PurchaseProduct>
  </ConversationCredits>
  <Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.Model">
    <d2p1:Code>String</d2p1:Code>
    <d2p1:CurrencyID>0</d2p1:CurrencyID>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Symbol>String</d2p1:Symbol>
  </Currency>
  <DefaultPaymentProvider>Verotel</DefaultPaymentProvider>
  <IsPaymentAvailable>false</IsPaymentAvailable>
  <IsStoredCardAvailable>false</IsStoredCardAvailable>
  <Message>String</Message>
  <NonSubscriptionProducts>
    <PurchaseProduct>
      <AppleProduct>String</AppleProduct>
      <CanBePurchased>false</CanBePurchased>
      <Cost>
        <Price>0</Price>
      </Cost>
      <Name>String</Name>
      <PaymentIcon>String</PaymentIcon>
      <Token>String</Token>
      <Type>String</Type>
    </PurchaseProduct>
  </NonSubscriptionProducts>
  <PaymentOptions xmlns:d2p1="http://schemas.datacontract.org/2004/07/RHP.Model">
    <d2p1:PaymentProvider>Verotel</d2p1:PaymentProvider>
  </PaymentOptions>
  <ProductOptions>
    <ProductOptions>Membership</ProductOptions>
  </ProductOptions>
  <Products>
    <MembershipProduct>
      <Alias>String</Alias>
      <CanBePurchased>false</CanBePurchased>
      <Cost>
        <MembershipProductCostDuration>
          <Cost>
            <DiscountType>NoDiscount</DiscountType>
            <FullPrice>0</FullPrice>
            <MonthlyPrice>0</MonthlyPrice>
            <Price>0</Price>
            <SiteCode>String</SiteCode>
          </Cost>
          <Duration>
            <DurationType>Day</DurationType>
            <Length>0</Length>
          </Duration>
          <ProductID>String</ProductID>
          <ProductIDAndroid>String</ProductIDAndroid>
          <Token>String</Token>
          <VerotelSiteCode>String</VerotelSiteCode>
        </MembershipProductCostDuration>
      </Cost>
      <MemberLevel>Guest</MemberLevel>
      <MemberLevelValue>0</MemberLevelValue>
      <Name>String</Name>
    </MembershipProduct>
  </Products>
  <PurchaseToken>String</PurchaseToken>
  <ReturnCode>String</ReturnCode>
  <StoreCredits>
    <PurchaseProduct>
      <AppleProduct>String</AppleProduct>
      <CanBePurchased>false</CanBePurchased>
      <Cost>
        <Price>0</Price>
      </Cost>
      <Name>String</Name>
      <PaymentIcon>String</PaymentIcon>
      <Token>String</Token>
      <Type>String</Type>
    </PurchaseProduct>
  </StoreCredits>
  <UpgradePath>None</UpgradePath>
  <UserDiscount>NoDiscount</UserDiscount>
  <UserDiscountDetail>
    <Percentage>0</Percentage>
  </UserDiscountDetail>
  <VerotelPaymentOptions>
    <Link>String</Link>
    <Username>String</Username>
  </VerotelPaymentOptions>
</MembershipOptions>