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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSubscriptionPlansResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BackofficeApi.Dto">
  <SubscriptionPlans>
    <SubscriptionPlanDto>
      <CanBeSelectedByClient>false</CanBeSelectedByClient>
      <Id>0</Id>
      <Slug>String</Slug>
      <SubscriptionPlanDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Entities.Common">
        <d4p1:FreeOnClaim>
          <d4p1:Months>0</d4p1:Months>
        </d4p1:FreeOnClaim>
        <d4p1:FreeUntil>
          <d4p1:StopAt>0001-01-01T00:00:00</d4p1:StopAt>
        </d4p1:FreeUntil>
        <d4p1:Invoice>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:Period>Monthly</d4p1:Period>
        </d4p1:Invoice>
        <d4p1:MonthlyStripe>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Currency>String</d4p1:Currency>
          <d4p1:FreeStartUpMonths>0</d4p1:FreeStartUpMonths>
        </d4p1:MonthlyStripe>
      </SubscriptionPlanDetails>
    </SubscriptionPlanDto>
  </SubscriptionPlans>
</GetSubscriptionPlansResponse>