BackofficeApi

<back to all web services

GetSubscriptionRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/subscription/get

export module BackofficeApi
{
    // @ts-nocheck

    export class SubscriptionDetailsFreeUntil
    {

        public constructor(init?: Partial<SubscriptionDetailsFreeUntil>) { (Object as any).assign(this, init); }
    }

    export class SubscriptionDetailsInvoice
    {

        public constructor(init?: Partial<SubscriptionDetailsInvoice>) { (Object as any).assign(this, init); }
    }

    export class SubscriptionDetailsStripe
    {
        public stripeX?: string;
        public cardExpiresAtMonth?: number;
        public cardExpiresAtYear?: number;

        public constructor(init?: Partial<SubscriptionDetailsStripe>) { (Object as any).assign(this, init); }
    }

    export class SubscriptionDetailsFreeOnClaim
    {

        public constructor(init?: Partial<SubscriptionDetailsFreeOnClaim>) { (Object as any).assign(this, init); }
    }

    export class SubscriptionDetailsUnion
    {
        public freeUntil?: SubscriptionDetailsFreeUntil;
        public invoice?: SubscriptionDetailsInvoice;
        public stripe?: SubscriptionDetailsStripe;
        public freeOnClaim?: SubscriptionDetailsFreeOnClaim;

        public constructor(init?: Partial<SubscriptionDetailsUnion>) { (Object as any).assign(this, init); }
    }

}

TypeScript GetSubscriptionRequest DTOs

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

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