BackofficeApi

GetSubscriptionPlansRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

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

**GetSubscriptionPlansResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionPlans	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 .jsv suffix or ?format=jsv

HTTP + JSV

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: backoffice-api.brovs.com 
Accept: text/jsv

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

{
	subscriptionPlans: 
	[
		{
			id: 0,
			canBeSelectedByClient: False,
			slug: String,
			subscriptionPlanDetails: 
			{
				freeUntil: 
				{
					stopAt: 0001-01-01
				},
				invoice: 
				{
					period: Monthly,
					amount: 0,
					currency: String
				},
				monthlyStripe: 
				{
					amount: 0,
					currency: String,
					freeStartUpMonths: 0
				},
				freeOnClaim: 
				{
					months: 0
				}
			}
		}
	]
}