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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"subscriptionPlan":[{"id":0,"canBeSelectedByClient":false,"slug":"String","subscriptionPlanDetails":{"freeUntil":{"stopAt":"0001-01-01T00:00:00.0000000Z"},"invoice":{"period":"Monthly","amount":0,"currency":"String"},"monthlyStripe":{"amount":0,"currency":"String","freeStartUpMonths":0},"freeOnClaim":{"months":0}}}]}