Merge pull request #216 from prezly/feature/support-plan-api

[DEV-10153] Feature - Support Plan API
prezly · Feb 22, 2023 · 4ddb008 · 4ddb008
2 parents ca2cbef + 7240c89
commit 4ddb008
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 10 deletions.
diff --git a/src/endpoints/Billing/Client.ts b/src/endpoints/Billing/Client.ts
@@ -1,5 +1,6 @@
 import type { DeferredJobsApiClient } from '../../api';
 import { routing } from '../../routing';
+import type { Plan } from '../../types';
 
 import type { SignupRequest, SignupResponse } from './types';
 
@@ -14,4 +15,9 @@ export class Client {
         const url = `${routing.billing}/signup`;
         return this.apiClient.post<SignupResponse>(url, { payload });
     }
+
+    async getPlan(): Promise<Plan> {
+        const { plan } = await this.apiClient.get<{ plan: Plan }>(`${routing.billing}/plan`);
+        return plan;
+    }
 }
diff --git a/src/types/License.ts b/src/types/License.ts
@@ -1,5 +1,5 @@
 import type { Currency } from './Currency';
-import type { PlanLevel } from './Plan';
+import type { PlanLevel, PlanReference } from './Plan';
 
 export interface LicenseRef {
     id: number;
@@ -62,7 +62,7 @@ export interface License extends LicenseRef {
      * use "plan" instead.
      */
     plan_level: PlanLevel | null;
-    plan: License.Plan | null;
+    plan: PlanReference | null;
     status: License.Status;
     subscription_lockout: boolean;
     /**
@@ -112,12 +112,4 @@ export namespace License {
         CANCELED = 'canceled',
         UNPAID = 'unpaid',
     }
-
-    export interface Plan {
-        display_name: string | null;
-        description: string | null;
-        is_legacy: boolean;
-        is_superior: boolean;
-        pricing_table_option_id: string | null;
-    }
 }
diff --git a/src/types/Plan.ts b/src/types/Plan.ts
@@ -1,3 +1,27 @@
+import type { Limit } from '../endpoints/PricingTables';
+
+export interface PlanReference {
+    display_name: string;
+    description: string | null;
+    is_legacy: boolean;
+    is_deprecated: boolean;
+    is_superior: boolean;
+    is_trial: boolean;
+    pricing_table_option_id: string | null;
+}
+
+export interface Plan extends PlanReference {
+    billing_cycle: string;
+    currency: string;
+    usage: Usage[];
+}
+
+export interface Usage {
+    limit: Limit;
+    used: number;
+}
+
+/** @deprecated Will be dropped in future */
 export enum PlanLevel {
     BASIC = 'basic',
     CORE = 'core',