BusinessApi

<back to all web services

GetSubscriptionRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/subscription/get
GetSubscriptionRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdquerylongNo
GetSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionformList<SubscriptionDto>Yes
SubscriptionDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BusinessIdformlongNo
SubscriptionPlanIdformlongNo
SubscriptionDetailsformSubscriptionDetailsUnionYes
SubscriptionDetailsUnion Parameters:
NameParameterData TypeRequiredDescription
FreeUntilformSubscriptionDetailsFreeUntilNo
InvoiceformSubscriptionDetailsInvoiceNo
StripeformSubscriptionDetailsStripeNo
FreeOnClaimformSubscriptionDetailsFreeOnClaimNo
SubscriptionDetailsStripe Parameters:
NameParameterData TypeRequiredDescription
StripeXformstringNo
CardExpiresAtMonthformintNo
CardExpiresAtYearformintNo

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 HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	subscription: 
	[
		{
			id: 0,
			businessId: 0,
			subscriptionPlanId: 0,
			subscriptionDetails: 
			{
				freeUntil: {},
				invoice: {},
				stripe: 
				{
					stripeX: String,
					cardExpiresAtMonth: 0,
					cardExpiresAtYear: 0
				},
				freeOnClaim: {}
			}
		}
	]
}