BackofficeApi

GetSubscriptionRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

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

"use strict";
export class SubscriptionDetailsFreeUntil {
    constructor(init) { Object.assign(this, init) }
}
export class SubscriptionDetailsInvoice {
    constructor(init) { Object.assign(this, init) }
}
export class SubscriptionDetailsStripe {
    /** @param {{stripeX?:string,cardExpiresAtMonth?:number,cardExpiresAtYear?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    stripeX;
    /** @type {?number} */
    cardExpiresAtMonth;
    /** @type {?number} */
    cardExpiresAtYear;
}
export class SubscriptionDetailsFreeOnClaim {
    constructor(init) { Object.assign(this, init) }
}
export class SubscriptionDetailsUnion {
    /** @param {{freeUntil?:SubscriptionDetailsFreeUntil,invoice?:SubscriptionDetailsInvoice,stripe?:SubscriptionDetailsStripe,freeOnClaim?:SubscriptionDetailsFreeOnClaim}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?SubscriptionDetailsFreeUntil} */
    freeUntil;
    /** @type {?SubscriptionDetailsInvoice} */
    invoice;
    /** @type {?SubscriptionDetailsStripe} */
    stripe;
    /** @type {?SubscriptionDetailsFreeOnClaim} */
    freeOnClaim;
}

JavaScript GetSubscriptionRequest DTOs

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: backoffice-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/BackofficeApi.Dto">
  <Subscriptions>
    <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>
  </Subscriptions>
</GetSubscriptionResponse>