BusinessApi

GetSubscriptionPlansRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
GET	/subscription/get_plans

**GetSubscriptionPlansRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BusinessId	query	long	No

**GetSubscriptionPlansResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionPlan	form	List<SubscriptionPlanDto>	Yes

**SubscriptionPlanDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
CanBeSelectedByClient	form	bool	No
Slug	form	string	Yes
SubscriptionPlanDetails	form	SubscriptionPlanDetailsUnion	Yes

**SubscriptionPlanDetailsUnion** Parameters:
Name	Parameter	Data Type	Required
FreeUntil	form	PlanDetailsFreeUntil	No
Invoice	form	PlanDetailsInvoice	No
MonthlyStripe	form	PlanDetailsMonthlyStripe	No
FreeOnClaim	form	PlanDetailsFreeOnClaim	No

**PlanDetailsFreeUntil** Parameters:
Name	Parameter	Data Type	Required	Description
StopAt	form	DateTime	No

**PlanDetailsInvoice** Parameters:
Name	Parameter	Data Type	Required
Period	form	Period	No
Amount	form	double	No
Currency	form	string	No

**Period** Enum:
Monthly
Yearly

**PlanDetailsMonthlyStripe** Parameters:
Name	Parameter	Data Type	Required
Amount	form	double	No
Currency	form	string	No
FreeStartUpMonths	form	int?	No

**PlanDetailsFreeOnClaim** Parameters:
Name	Parameter	Data Type	Required	Description
Months	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 /subscription/get_plans HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml

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

<GetSubscriptionPlansResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <SubscriptionPlan>
    <SubscriptionPlanDto>
      <CanBeSelectedByClient>false</CanBeSelectedByClient>
      <Id>0</Id>
      <Slug>String</Slug>
      <SubscriptionPlanDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:FreeOnClaim>
          <d4p1:Months>0</d4p1:Months>
        </d4p1:FreeOnClaim>
        <d4p1:FreeUntil>
          <d4p1:StopAt>0001-01-01T00:00:00</d4p1:StopAt>
        </d4p1:FreeUntil>
        <d4p1:Invoice>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:Period>Monthly</d4p1:Period>
        </d4p1:Invoice>
        <d4p1:MonthlyStripe>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:FreeStartUpMonths>0</d4p1:FreeStartUpMonths>
        </d4p1:MonthlyStripe>
      </SubscriptionPlanDetails>
    </SubscriptionPlanDto>
  </SubscriptionPlan>
</GetSubscriptionPlansResponse>