BackofficeApi

UpdateSubscriptionPlanRequest

Backoffice

**Requires Authentication**
Required role:	Backoffice

The following routes are available for this service:
PUT	/subscription/update_plan


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 UpdateSubscriptionPlanRequest 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.

PUT /subscription/update_plan HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	canBeSelectedByClient: False,
	subscriptionPlanDetails: 
	{
		freeUntil: 
		{
			stopAt: 0001-01-01
		},
		invoice: 
		{
			period: Monthly,
			amount: 0,
			currency: String
		},
		monthlyStripe: 
		{
			amount: 0,
			currency: String,
			freeStartUpMonths: 0
		},
		freeOnClaim: 
		{
			months: 0
		}
	}
}

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

{
	success: False
}