ClubReady Api

GetSalesPackageDiscountsRequest

The following routes are available for this service:
GET	/sales/packages/{PackageId}/installments	Get sales package installments

**GetSalesPackageDiscountsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	string	Yes	ID # of store to get package plans for
PackageId	path	string	Yes	ID # of package to get installment plans for
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**GetSalesPackageInstallmentsDto** Parameters:
Name	Parameter	Data Type	Required	Description
PackageId	form	int	No

**ApiDtoBase** Parameters:
Name	Parameter	Data Type	Required
ApiKey	form	string	No
StoreId	form	int?	No
ChainId	form	int?	No

**RestrictedResourceType** Enum:
Store
Chain
User
Undefined

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 /sales/packages/{PackageId}/installments HTTP/1.1 
Host: clubready.com 
Accept: application/xml

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

<ArrayOfSalesPackageInstallmentPlanResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <SalesPackageInstallmentPlanResponse>
    <DuePerPayment>String</DuePerPayment>
    <Fees>
      <PackageFee>
        <Amount>String</Amount>
        <CanBeWaived>false</CanBeWaived>
        <CanDuplicate>false</CanDuplicate>
        <DueUpfront>false</DueUpfront>
        <Name>String</Name>
        <OneTime>false</OneTime>
        <PayFrequencyMonths>0</PayFrequencyMonths>
        <Taxable>false</Taxable>
      </PackageFee>
    </Fees>
    <ForOnlineSale>false</ForOnlineSale>
    <Id>0</Id>
    <PaymentCount>0</PaymentCount>
  </SalesPackageInstallmentPlanResponse>
</ArrayOfSalesPackageInstallmentPlanResponse>