BackofficeApi

GetSubscriptionPlansRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

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


export module BackofficeApi
{
    // @ts-nocheck

    export class PlanDetailsFreeUntil
    {
        public stopAt?: string;

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

    export enum Period
    {
        Monthly = 'Monthly',
        Yearly = 'Yearly',
    }

    export class PlanDetailsInvoice
    {
        public period?: Period;
        public amount?: number;
        public currency?: string;

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

    export class PlanDetailsMonthlyStripe
    {
        public amount?: number;
        public currency?: string;
        public freeStartUpMonths?: number;

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

    export class PlanDetailsFreeOnClaim
    {
        public months?: number;

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

    export class SubscriptionPlanDetailsUnion
    {
        public freeUntil?: PlanDetailsFreeUntil;
        public invoice?: PlanDetailsInvoice;
        public monthlyStripe?: PlanDetailsMonthlyStripe;
        public freeOnClaim?: PlanDetailsFreeOnClaim;

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

}

TypeScript GetSubscriptionPlansRequest DTOs

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_plans HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"subscriptionPlans":[{"id":0,"canBeSelectedByClient":false,"slug":"String","subscriptionPlanDetails":{"freeUntil":{"stopAt":"0001-01-01T00:00:00.0000000Z"},"invoice":{"period":"Monthly","amount":0,"currency":"String"},"monthlyStripe":{"amount":0,"currency":"String","freeStartUpMonths":0},"freeOnClaim":{"months":0}}}]}