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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSubscriptionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Subscription>
    <SubscriptionDto>
      <BusinessId>0</BusinessId>
      <Id>0</Id>
      <SubscriptionDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:FreeOnClaim />
        <d4p1:FreeUntil />
        <d4p1:Invoice />
        <d4p1:Stripe>
          <d4p1:CardExpiresAtMonth>0</d4p1:CardExpiresAtMonth>
          <d4p1:CardExpiresAtYear>0</d4p1:CardExpiresAtYear>
          <d4p1:StripeX>String</d4p1:StripeX>
        </d4p1:Stripe>
      </SubscriptionDetails>
      <SubscriptionPlanId>0</SubscriptionPlanId>
    </SubscriptionDto>
  </Subscription>
</GetSubscriptionResponse>