BusinessApi

<back to all web services

GetSubscriptionPlansRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/subscription/get_plans
GetSubscriptionPlansRequest Parameters:
NameParameterData TypeRequiredDescription
BusinessIdquerylongNo
GetSubscriptionPlansResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionPlanformList<SubscriptionPlanDto>Yes
SubscriptionPlanDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CanBeSelectedByClientformboolNo
SlugformstringYes
SubscriptionPlanDetailsformSubscriptionPlanDetailsUnionYes
SubscriptionPlanDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
FreeUntilformPlanDetailsFreeUntilNo
InvoiceformPlanDetailsInvoiceNo
MonthlyStripeformPlanDetailsMonthlyStripeNo
FreeOnClaimformPlanDetailsFreeOnClaimNo
PlanDetailsFreeUntil Parameters:
NameParameterData TypeRequiredDescription
StopAtformDateTimeNo
PlanDetailsInvoice Parameters:
NameParameterData TypeRequiredDescription
PeriodformPeriodNo
AmountformdoubleNo
CurrencyformstringNo
Period Enum:
Monthly
Yearly
PlanDetailsMonthlyStripe Parameters:
NameParameterData TypeRequiredDescription
AmountformdoubleNo
CurrencyformstringNo
FreeStartUpMonthsformint?No
PlanDetailsFreeOnClaim Parameters:
NameParameterData TypeRequiredDescription
MonthsformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}}}]}