@paid-ai/paid-node 1.0.1-alpha1 → 1.0.1-alpha2

package/dist/esm/integrations/controllers/plans.d.mts

@@ -1,6 +1,13 @@
 import { PaidClient } from "../../Client.mjs";
 import type { PlanGroup } from "../../api/types/PlanGroup.mjs";
 import type { Plan } from "../../api/types/Plan.mjs";
+import type { PlanWithFeatures } from "../../api/types/PlanWithFeatures.mjs";
+import type { Order } from "../../api/types/Order.mjs";
+import type { CancelRenewalResponse } from "../../api/types/CancelRenewalResponse.mjs";
+import type { ProrationUpgradeResponse } from "../../api/types/ProrationUpgradeResponse.mjs";
+import type { PlansSubscribeRequest } from "../../api/resources/plans/client/requests/PlansSubscribeRequest.mjs";
+import type { PlansUnsubscribeRequest } from "../../api/resources/plans/client/requests/PlansUnsubscribeRequest.mjs";
+import type { PlansUpgradeRequest } from "../../api/resources/plans/client/requests/PlansUpgradeRequest.mjs";
 /**
  * Get a plan by ID
  *
@@ -48,3 +55,154 @@ export declare function getPlanGroupById(client: PaidClient, planGroupId: string
  * ```
  */
 export declare function createGetPlanGroupByIdHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Get all plans in a plan group
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Array of plans with features
+ *
+ * @example
+ * ```typescript
+ * const plans = await getGroupPlans(client, 'plan-group-123');
+ * console.log(plans.length);
+ * ```
+ */
+export declare function getGroupPlans(client: PaidClient, planGroupId: string): Promise<PlanWithFeatures[]>;
+/**
+ * Create a framework-agnostic handler for fetching plans in a plan group
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetGroupPlansHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createGetGroupPlansHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Subscribe a customer to a plan
+ *
+ * Creates a new order for a customer based on the specified plan, automatically converting plan products to order lines.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Subscribe request with customer external ID and currency
+ * @returns Created order
+ *
+ * @example
+ * ```typescript
+ * const order = await subscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123',
+ *   currency: 'USD'
+ * });
+ * console.log(order.id);
+ * ```
+ */
+export declare function subscribe(client: PaidClient, planId: string, request: PlansSubscribeRequest): Promise<Order>;
+/**
+ * Create a framework-agnostic handler for subscribing a customer to a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId and currency.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createSubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createSubscribeHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Unsubscribe a customer from a plan
+ *
+ * Cancels the renewal of an order associated with the specified plan. The order will remain active until the cancellation date.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Unsubscribe request with customer external ID
+ * @returns Cancel renewal response
+ *
+ * @example
+ * ```typescript
+ * const response = await unsubscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123'
+ * });
+ * console.log(response.message);
+ * ```
+ */
+export declare function unsubscribe(client: PaidClient, planId: string, request: PlansUnsubscribeRequest): Promise<CancelRenewalResponse>;
+/**
+ * Create a framework-agnostic handler for unsubscribing a customer from a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUnsubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createUnsubscribeHandler(): (request: any, response: any, config?: any) => Promise<any>;
+/**
+ * Upgrade a customer from their current plan to a new plan
+ *
+ * Upgrades a customer from their current plan to a new plan with automatic proration calculation. This schedules a plan change and applies credits for the unused portion of the current billing period.
+ *
+ * @param client - PaidClient instance
+ * @param request - Upgrade request with customer external ID, old plan ID, and new plan ID
+ * @returns Proration upgrade response
+ *
+ * @example
+ * ```typescript
+ * const response = await upgrade(client, {
+ *   customerExternalId: 'customer-123',
+ *   oldPlanId: 'plan-123',
+ *   newPlanId: 'plan-456'
+ * });
+ * console.log(response.order.id);
+ * ```
+ */
+export declare function upgrade(client: PaidClient, request: PlansUpgradeRequest): Promise<ProrationUpgradeResponse>;
+/**
+ * Create a framework-agnostic handler for upgrading a customer's plan
+ *
+ * This handler can be used with any framework adapter.
+ * The request body should contain customerExternalId, oldPlanId, and newPlanId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/upgrade/route.ts
+ * import { createUpgradeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUpgradeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export declare function createUpgradeHandler(): (request: any, response: any, config?: any) => Promise<any>;

package/dist/esm/integrations/controllers/plans.mjs

@@ -82,3 +82,272 @@ export function createGetPlanGroupByIdHandler() {
         requireOrganizationId: false,
     });
 }
+/**
+ * Get all plans in a plan group
+ *
+ * @param client - PaidClient instance
+ * @param planGroupId - Plan group's ID
+ * @returns Array of plans with features
+ *
+ * @example
+ * ```typescript
+ * const plans = await getGroupPlans(client, 'plan-group-123');
+ * console.log(plans.length);
+ * ```
+ */
+export function getGroupPlans(client, planGroupId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const plans = yield client.plans.getGroupPlans(planGroupId);
+        return plans;
+    });
+}
+/**
+ * Create a framework-agnostic handler for fetching plans in a plan group
+ *
+ * This handler can be used with any framework adapter.
+ * The plan group ID should be provided either in params or query string.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createGetGroupPlansHandler();
+ * export const GET = nextjsAdapter(handler);
+ * ```
+ */
+export function createGetGroupPlansHandler() {
+    return createHandler((client, _body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planGroupId = params === null || params === void 0 ? void 0 : params.planGroupId;
+        if (!planGroupId) {
+            return {
+                success: false,
+                error: "planGroupId is required",
+                status: 400,
+            };
+        }
+        const plans = yield getGroupPlans(client, planGroupId);
+        return { success: true, data: plans };
+    }), {
+        allowedMethods: ['GET'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Subscribe a customer to a plan
+ *
+ * Creates a new order for a customer based on the specified plan, automatically converting plan products to order lines.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Subscribe request with customer external ID and currency
+ * @returns Created order
+ *
+ * @example
+ * ```typescript
+ * const order = await subscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123',
+ *   currency: 'USD'
+ * });
+ * console.log(order.id);
+ * ```
+ */
+export function subscribe(client, planId, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const order = yield client.plans.subscribe(planId, request);
+        return order;
+    });
+}
+/**
+ * Create a framework-agnostic handler for subscribing a customer to a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId and currency.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createSubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export function createSubscribeHandler() {
+    return createHandler((client, body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planId = params === null || params === void 0 ? void 0 : params.planId;
+        if (!planId) {
+            return {
+                success: false,
+                error: "planId is required",
+                status: 400,
+            };
+        }
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        if (!body.currency) {
+            return {
+                success: false,
+                error: "currency is required",
+                status: 400,
+            };
+        }
+        const order = yield subscribe(client, planId, body);
+        return { success: true, data: order };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Unsubscribe a customer from a plan
+ *
+ * Cancels the renewal of an order associated with the specified plan. The order will remain active until the cancellation date.
+ *
+ * @param client - PaidClient instance
+ * @param planId - Plan's ID
+ * @param request - Unsubscribe request with customer external ID
+ * @returns Cancel renewal response
+ *
+ * @example
+ * ```typescript
+ * const response = await unsubscribe(client, 'plan-123', {
+ *   customerExternalId: 'customer-123'
+ * });
+ * console.log(response.message);
+ * ```
+ */
+export function unsubscribe(client, planId, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield client.plans.unsubscribe(planId, request);
+        return response;
+    });
+}
+/**
+ * Create a framework-agnostic handler for unsubscribing a customer from a plan
+ *
+ * This handler can be used with any framework adapter.
+ * The plan ID should be provided either in params or query string.
+ * The request body should contain customerExternalId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUnsubscribeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export function createUnsubscribeHandler() {
+    return createHandler((client, body, params) => __awaiter(this, void 0, void 0, function* () {
+        const planId = params === null || params === void 0 ? void 0 : params.planId;
+        if (!planId) {
+            return {
+                success: false,
+                error: "planId is required",
+                status: 400,
+            };
+        }
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        const response = yield unsubscribe(client, planId, body);
+        return { success: true, data: response };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}
+/**
+ * Upgrade a customer from their current plan to a new plan
+ *
+ * Upgrades a customer from their current plan to a new plan with automatic proration calculation. This schedules a plan change and applies credits for the unused portion of the current billing period.
+ *
+ * @param client - PaidClient instance
+ * @param request - Upgrade request with customer external ID, old plan ID, and new plan ID
+ * @returns Proration upgrade response
+ *
+ * @example
+ * ```typescript
+ * const response = await upgrade(client, {
+ *   customerExternalId: 'customer-123',
+ *   oldPlanId: 'plan-123',
+ *   newPlanId: 'plan-456'
+ * });
+ * console.log(response.order.id);
+ * ```
+ */
+export function upgrade(client, request) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield client.plans.upgrade(request);
+        return response;
+    });
+}
+/**
+ * Create a framework-agnostic handler for upgrading a customer's plan
+ *
+ * This handler can be used with any framework adapter.
+ * The request body should contain customerExternalId, oldPlanId, and newPlanId.
+ *
+ * @returns Handler function
+ *
+ * @example
+ * ```typescript
+ * // In Next.js route: /api/plans/upgrade/route.ts
+ * import { createUpgradeHandler } from '@paid-ai/paid-node/integrations';
+ * import { nextjsAdapter } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * const handler = createUpgradeHandler();
+ * export const POST = nextjsAdapter(handler);
+ * ```
+ */
+export function createUpgradeHandler() {
+    return createHandler((client, body) => __awaiter(this, void 0, void 0, function* () {
+        if (!body.customerExternalId) {
+            return {
+                success: false,
+                error: "customerExternalId is required",
+                status: 400,
+            };
+        }
+        if (!body.oldPlanId) {
+            return {
+                success: false,
+                error: "oldPlanId is required",
+                status: 400,
+            };
+        }
+        if (!body.newPlanId) {
+            return {
+                success: false,
+                error: "newPlanId is required",
+                status: 400,
+            };
+        }
+        const response = yield upgrade(client, body);
+        return { success: true, data: response };
+    }), {
+        allowedMethods: ['POST'],
+        requireOrganizationId: false,
+    });
+}

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "1.0.1-alpha1";
+export declare const SDK_VERSION = "1.0.1-alpha2";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "1.0.1-alpha1";
+export const SDK_VERSION = "1.0.1-alpha2";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@paid-ai/paid-node",
-    "version": "1.0.1-alpha1",
+    "version": "1.0.1-alpha2",
     "private": false,
     "repository": "github:paid-ai/paid-node",
     "type": "commonjs",

package/reference.md

@@ -2775,6 +2775,220 @@ await client.plans.getUsage("planId", {
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">subscribe</a>(planId, { ...params }) -> Paid.Order</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.subscribe("planId", {
+    customerExternalId: "customerExternalId",
+    currency: "currency"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planId:** `string` — The ID of the plan
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansSubscribeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">unsubscribe</a>(planId, { ...params }) -> Paid.CancelRenewalResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.unsubscribe("planId", {
+    customerExternalId: "customerExternalId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**planId:** `string` — The ID of the plan
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansUnsubscribeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.plans.<a href="/src/api/resources/plans/client/Client.ts">upgrade</a>({ ...params }) -> Paid.ProrationUpgradeResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Upgrades a customer from one plan to another with automatic proration. Credits are applied for the unused portion of the current billing period, and the order is updated with the new plan's pricing.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.plans.upgrade({
+    customerExternalId: "customerExternalId",
+    oldPlanId: "oldPlanId",
+    newPlanId: "newPlanId"
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Paid.PlansUpgradeRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Plans.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -2832,6 +3046,20 @@ await client.plans.getGroupById("planGroupId");
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves all plans in a plan group with their features (product-attribute pairs)
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>