BackofficeApi

<back to all web services

GetSubscriptionRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/subscription/get
GetSubscriptionRequest Parameters:
NameParameterData TypeRequiredDescription
BusinessIdquerylongNo
GetSubscriptionResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionsformList<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 .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 HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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