ClubReady Api

CalculatePaymentPlanRequest

The following routes are available for this service:
GET	/sales/packages/{PackageId}/installments/calculate/{InstallmentPlanId}	Get customer's billing status

**CalculatePaymentPlanRequest** Parameters:
Name	Parameter	Data Type	Required	Description
XForwardedFor	header	string	No	IP address of the end user
ApiKey	query	string	Yes	Api Key - grants access to resources
StoreId	query	integer	Yes	ID # of store to calculate plan for
InstallmentPlanId	path	integer	Yes	Installment Plan to calculate a scheduel for
PackageId	path	integer	Yes	The package to calculate for
StartDate	query	datetime	No	Date to calculate schedule from. If not provided, will use today.
PromoCode	query	string	No	Promo code to apply a discount.
RestrictedId	query	int?	No
RestrictedResourceType	query	RestrictedResourceType	No

**CalculatePaymentPlanRequestDto** Parameters:
Name	Parameter	Data Type	Required
InstallmentPlanId	form	int	No
PackageId	form	int	No
StartDate	form	DateTime?	No
PromoCode	form	string	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

**CalculatePaymentPlanResultDto** Parameters:
Name	Parameter	Data Type	Required
PlanTotal	form	string	No
SubTotal	form	string	No
TaxRate	form	float?	No
EnhancementFee	form	string	No
EnhancementFeeTaxAmount	form	string	No
TaxEnhFee	form	bool	No
Tax	form	string	No
TotalDueToday	form	string	No
Payments	form	List<PaymentPlanInstallment>	No
Fees	form	List<PaymentPlanInstallment>	No
IsEvergreen	form	bool	No
RequirePaymentProfile	form	bool	No

**PaymentPlanInstallment** Parameters:
Name	Parameter	Data Type	Required
PayToday	form	bool	No
Amount	form	decimal	No
Taxed	form	bool	No
TaxRate	form	float?	No
TaxAmount	form	decimal?	No
FeeName	form	string	No
DueDate	form	DateTime	No
Total	form	string	No
SetupFeeId	form	int?	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 /sales/packages/{PackageId}/installments/calculate/{InstallmentPlanId} HTTP/1.1 
Host: www.clubready.com 
Accept: application/xml

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

<CalculatePaymentPlanResultDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
  <EnhancementFee>String</EnhancementFee>
  <Fees>
    <PaymentPlanInstallment>
      <Amount>0</Amount>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <FeeName>String</FeeName>
      <PayToday>false</PayToday>
      <SetupFeeId>0</SetupFeeId>
      <TaxRate>0</TaxRate>
      <Taxed>false</Taxed>
    </PaymentPlanInstallment>
  </Fees>
  <IsEvergreen>false</IsEvergreen>
  <Payments>
    <PaymentPlanInstallment>
      <Amount>0</Amount>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <FeeName>String</FeeName>
      <PayToday>false</PayToday>
      <SetupFeeId>0</SetupFeeId>
      <TaxRate>0</TaxRate>
      <Taxed>false</Taxed>
    </PaymentPlanInstallment>
  </Payments>
  <TaxEnhFee>false</TaxEnhFee>
  <TaxRate>0</TaxRate>
</CalculatePaymentPlanResultDto>