BusinessApi

<back to all web services

GetSubscriptionRequest

Business
Requires Authentication
Required role:Business
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 .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: {}
			}
		}
	]
}