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

package/dist/esm/api/types/PlanWithFeatures.mjs

@@ -0,0 +1,19 @@
+// This file was auto-generated by Fern from our API Definition.
+export var PlanWithFeatures;
+(function (PlanWithFeatures) {
+    /** The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits) */
+    PlanWithFeatures.Type = {
+        Flat: "flat",
+        Usage: "usage",
+        Credit: "credit",
+    };
+    let Pricing;
+    (function (Pricing) {
+        /** The billing frequency for the plan */
+        Pricing.BillingFrequency = {
+            Monthly: "monthly",
+            Quarterly: "quarterly",
+            Annual: "annual",
+        };
+    })(Pricing = PlanWithFeatures.Pricing || (PlanWithFeatures.Pricing = {}));
+})(PlanWithFeatures || (PlanWithFeatures = {}));

package/dist/esm/api/types/SignalV2.d.mts

@@ -1,16 +1,16 @@
 /**
- * V2 signal schema with clean field names. Use either internal IDs (product_id, customer_id) or external IDs (external_product_id, external_customer_id).
+ * V2 signal schema with clean field names. IMPORTANT: Exactly one customer ID field (customer_id OR external_customer_id) and exactly one product ID field (product_id OR external_product_id) must be provided per signal.
  */
 export interface SignalV2 {
     /** The name of the event being tracked */
     event_name: string;
-    /** Paid's internal product ID. Use either this OR external_product_id. */
+    /** Paid's display ID for the product (e.g., prod_abc123). Cannot be used with external_product_id. Either this or external_product_id is required. */
     product_id?: string;
-    /** Your system's product ID. Use either this OR product_id. */
+    /** Your system's product ID. Cannot be used with product_id. Either this or product_id is required. */
     external_product_id?: string;
-    /** Paid's internal customer ID. Use either this OR external_customer_id. */
+    /** Paid's display ID for the customer (e.g., cus_xyz789). Cannot be used with external_customer_id. Either this or external_customer_id is required. */
     customer_id?: string;
-    /** Your system's customer ID. Use either this OR customer_id. */
+    /** Your system's customer ID. Cannot be used with customer_id. Either this or customer_id is required. */
     external_customer_id?: string;
     /** Optional additional data/metadata for the signal */
     data?: Record<string, unknown>;

package/dist/esm/api/types/index.d.mts

@@ -30,6 +30,7 @@ export * from "./PaginationMeta.mjs";
 export * from "./PaymentMethod.mjs";
 export * from "./Plan.mjs";
 export * from "./PlanGroup.mjs";
+export * from "./PlanWithFeatures.mjs";
 export * from "./PricePoint.mjs";
 export * from "./Pricing.mjs";
 export * from "./PricingModelType.mjs";

package/dist/esm/api/types/index.mjs

@@ -30,6 +30,7 @@ export * from "./PaginationMeta.mjs";
 export * from "./PaymentMethod.mjs";
 export * from "./Plan.mjs";
 export * from "./PlanGroup.mjs";
+export * from "./PlanWithFeatures.mjs";
 export * from "./PricePoint.mjs";
 export * from "./Pricing.mjs";
 export * from "./PricingModelType.mjs";

package/dist/esm/integrations/adapters/expressjs/index.d.mts

@@ -2,5 +2,5 @@
  * ExpressJS integration for Paid SDK
  * Drop-in handlers for ExpressJS controllers using Express Request/Response
  */
-export { expressjsAdapter, createExpressJSResponseContext } from "./base-adapter.mjs";
-export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, type ActivateOrderSyncRouteConfig, type OrdersRouteConfig, type ProvisioningRouteConfig, type SetupIntentRouteConfig, } from "./routes.mjs";
+export { expressjsAdapter, createExpressJSResponseContext, } from "./base-adapter.mjs";
+export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createGetPlanGroupByIdRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, type ActivateOrderSyncRouteConfig, type OrdersRouteConfig, type ProvisioningRouteConfig, type SetupIntentRouteConfig, } from "./routes.mjs";

package/dist/esm/integrations/adapters/expressjs/index.mjs

@@ -2,5 +2,5 @@
  * ExpressJS integration for Paid SDK
  * Drop-in handlers for ExpressJS controllers using Express Request/Response
  */
-export { expressjsAdapter, createExpressJSResponseContext } from "./base-adapter.mjs";
-export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, } from "./routes.mjs";
+export { expressjsAdapter, createExpressJSResponseContext, } from "./base-adapter.mjs";
+export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createGetPlanGroupByIdRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, } from "./routes.mjs";

package/dist/esm/integrations/adapters/expressjs/routes.d.mts

@@ -161,4 +161,20 @@ export interface SetupIntentRouteConfig extends BaseHandlerConfig {
  * ```
  */
 export declare function createSetupIntentRoute(config?: SetupIntentRouteConfig): ExpressHandler;
+/**
+ * Create an Express handler for getting a plan group by ID
+ *
+ * @param config - Handler configuration options
+ * @returns Express route handler function
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { createGetPlanGroupByIdRoute } from '@paid-ai/paid-node/integrations/express';
+ *
+ * const app = express();
+ * app.get('/paid/plans/:planGroupId', createGetPlanGroupByIdRoute());
+ * ```
+ */
+export declare function createGetPlanGroupByIdRoute(config?: BaseHandlerConfig): (req: Request, res: Response) => Promise<any>;
 export {};

package/dist/esm/integrations/adapters/expressjs/routes.mjs

@@ -9,6 +9,7 @@ import { createCustomersHandler, createGetCustomerHandler } from "../../controll
 import { createOrdersHandler } from "../../controllers/orders.mjs";
 import { createProvisioningHandler } from "../../controllers/provision-users.mjs";
 import { createActivateOrderSyncHandler, createPayInvoiceHandler, createSetupIntentHandler, } from "../../controllers/billing.mjs";
+import { createGetPlanGroupByIdHandler } from "../../controllers/plans.mjs";
 /**
  * Helper to extract headers from Express Request
  */
@@ -265,3 +266,29 @@ export function createSetupIntentRoute(config = {}) {
     };
     return route;
 }
+/**
+ * Create an Express handler for getting a plan group by ID
+ *
+ * @param config - Handler configuration options
+ * @returns Express route handler function
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { createGetPlanGroupByIdRoute } from '@paid-ai/paid-node/integrations/express';
+ *
+ * const app = express();
+ * app.get('/paid/plans/:planGroupId', createGetPlanGroupByIdRoute());
+ * ```
+ */
+export function createGetPlanGroupByIdRoute(config = {}) {
+    const handler = createGetPlanGroupByIdHandler();
+    return (req, res) => {
+        return handler({
+            body: req.body,
+            headers: extractHeaders(req),
+            method: "GET",
+            params: req.params,
+        }, createExpressJSResponseContext(res), config);
+    };
+}

package/dist/esm/integrations/adapters/nextjs/index.d.mts

@@ -2,4 +2,4 @@
  * Next.js API Route handlers for Paid integration
  * Drop-in handlers for Next.js App Router
  */
-export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, type ActivateOrderSyncRouteConfig, type OrdersRouteConfig, type ProvisioningRouteConfig, type SetupIntentRouteConfig, } from './routes.mjs';
+export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createGetPlanGroupByIdRoute, createGetGroupPlansRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, createSubscribeRoute, createUnsubscribeRoute, createUpgradeRoute, type ActivateOrderSyncRouteConfig, type OrdersRouteConfig, type ProvisioningRouteConfig, type SetupIntentRouteConfig, } from "./routes.mjs";

package/dist/esm/integrations/adapters/nextjs/index.mjs

@@ -2,4 +2,4 @@
  * Next.js API Route handlers for Paid integration
  * Drop-in handlers for Next.js App Router
  */
-export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, } from './routes.mjs';
+export { createActivateOrderSyncRoute, createContactsRoute, createCustomerInvoicesRoute, createCustomersRoute, createGetCustomerRoute, createGetPlanGroupByIdRoute, createGetGroupPlansRoute, createOrdersRoute, createPayInvoiceRoute, createProvisioningRoute, createSetupIntentRoute, createSubscribeRoute, createUnsubscribeRoute, createUpgradeRoute, } from "./routes.mjs";

package/dist/esm/integrations/adapters/nextjs/routes.d.mts

@@ -224,4 +224,79 @@ export interface SetupIntentRouteConfig extends BaseHandlerConfig {
  * ```
  */
 export declare function createSetupIntentRoute(config?: SetupIntentRouteConfig): NextJsHandler;
+/**
+ * Create a Next.js API route handler for getting a plan group by ID
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planGroupId]/route.ts
+ * import { createGetPlanGroupByIdRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const GET = createGetPlanGroupByIdRoute();
+ * ```
+ */
+export declare function createGetPlanGroupByIdRoute(config?: BaseHandlerConfig): (request: any, context?: any) => Promise<any>;
+/**
+ * Create a Next.js API route handler for getting all plans in a plan group
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const GET = createGetGroupPlansRoute();
+ * ```
+ */
+export declare function createGetGroupPlansRoute(config?: BaseHandlerConfig): (request: any, context?: any) => Promise<any>;
+/**
+ * Create a Next.js API route handler for subscribing a customer to a plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createSubscribeRoute();
+ * ```
+ */
+export declare function createSubscribeRoute(config?: BaseHandlerConfig): (request: any, context?: any) => Promise<any>;
+/**
+ * Create a Next.js API route handler for unsubscribing a customer from a plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createUnsubscribeRoute();
+ * ```
+ */
+export declare function createUnsubscribeRoute(config?: BaseHandlerConfig): (request: any, context?: any) => Promise<any>;
+/**
+ * Create a Next.js API route handler for upgrading a customer's plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/upgrade/route.ts
+ * import { createUpgradeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createUpgradeRoute();
+ * ```
+ */
+export declare function createUpgradeRoute(config?: BaseHandlerConfig): (request: any, context?: any) => Promise<any>;
 export {};

package/dist/esm/integrations/adapters/nextjs/routes.mjs

@@ -5,6 +5,7 @@ import { createCustomersHandler, createGetCustomerHandler } from "../../controll
 import { createOrdersHandler } from "../../controllers/orders.mjs";
 import { createProvisioningHandler } from "../../controllers/provision-users.mjs";
 import { createActivateOrderSyncHandler, createPayInvoiceHandler, createSetupIntentHandler } from "../../controllers/billing.mjs";
+import { createGetPlanGroupByIdHandler, createGetGroupPlansHandler, createSubscribeHandler, createUnsubscribeHandler, createUpgradeHandler } from "../../controllers/plans.mjs";
 /**
  * Create a Next.js API route handler for synchronous order activation
  *
@@ -242,3 +243,98 @@ export function createSetupIntentRoute(config = {}) {
     const route = (request, context) => adaptedHandler(request, context, config);
     return route;
 }
+/**
+ * Create a Next.js API route handler for getting a plan group by ID
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planGroupId]/route.ts
+ * import { createGetPlanGroupByIdRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const GET = createGetPlanGroupByIdRoute();
+ * ```
+ */
+export function createGetPlanGroupByIdRoute(config = {}) {
+    const handler = createGetPlanGroupByIdHandler();
+    const adaptedHandler = nextjsAdapter(handler);
+    return (request, context) => adaptedHandler(request, context, config);
+}
+/**
+ * Create a Next.js API route handler for getting all plans in a plan group
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planGroupId]/plans/route.ts
+ * import { createGetGroupPlansRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const GET = createGetGroupPlansRoute();
+ * ```
+ */
+export function createGetGroupPlansRoute(config = {}) {
+    const handler = createGetGroupPlansHandler();
+    const adaptedHandler = nextjsAdapter(handler);
+    return (request, context) => adaptedHandler(request, context, config);
+}
+/**
+ * Create a Next.js API route handler for subscribing a customer to a plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planId]/subscribe/route.ts
+ * import { createSubscribeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createSubscribeRoute();
+ * ```
+ */
+export function createSubscribeRoute(config = {}) {
+    const handler = createSubscribeHandler();
+    const adaptedHandler = nextjsAdapter(handler);
+    return (request, context) => adaptedHandler(request, context, config);
+}
+/**
+ * Create a Next.js API route handler for unsubscribing a customer from a plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/[planId]/unsubscribe/route.ts
+ * import { createUnsubscribeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createUnsubscribeRoute();
+ * ```
+ */
+export function createUnsubscribeRoute(config = {}) {
+    const handler = createUnsubscribeHandler();
+    const adaptedHandler = nextjsAdapter(handler);
+    return (request, context) => adaptedHandler(request, context, config);
+}
+/**
+ * Create a Next.js API route handler for upgrading a customer's plan
+ *
+ * @param config - Handler configuration options
+ * @returns Next.js route handler function
+ *
+ * @example
+ * ```typescript
+ * // src/app/api/plans/upgrade/route.ts
+ * import { createUpgradeRoute } from '@paid-ai/paid-node/integrations/nextjs';
+ *
+ * export const POST = createUpgradeRoute();
+ * ```
+ */
+export function createUpgradeRoute(config = {}) {
+    const handler = createUpgradeHandler();
+    const adaptedHandler = nextjsAdapter(handler);
+    return (request, context) => adaptedHandler(request, context, config);
+}

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

@@ -4,3 +4,4 @@ export { createOrder, createOrderWithDefaults, createOrdersHandler, } from "./or
 export { payInvoice, createPayInvoiceHandler, type PayInvoiceConfig, type PayInvoiceRequest, type PayInvoiceResult, activateOrderSync, createActivateOrderSyncHandler, type ActivateOrderSyncConfig, type ActivateOrderSyncRequest, type ActivateOrderSyncResult, createSetupIntent, createSetupIntentHandler, type SetupIntentConfig, type SetupIntentRequest, type SetupIntentResponse, } from "./billing.mjs";
 export { getCustomerInvoices, createCustomerInvoicesHandler, type CustomerInvoicesResult, } from "./invoices.mjs";
 export { provisionNewUser, createProvisioningHandler, } from "./provision-users.mjs";
+export { getPlanById, getPlanGroupById, createGetPlanGroupByIdHandler, getGroupPlans, createGetGroupPlansHandler, subscribe, createSubscribeHandler, unsubscribe, createUnsubscribeHandler, upgrade, createUpgradeHandler, } from "./plans.mjs";

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

@@ -4,3 +4,4 @@ export { createOrder, createOrderWithDefaults, createOrdersHandler, } from "./or
 export { payInvoice, createPayInvoiceHandler, activateOrderSync, createActivateOrderSyncHandler, createSetupIntent, createSetupIntentHandler, } from "./billing.mjs";
 export { getCustomerInvoices, createCustomerInvoicesHandler, } from "./invoices.mjs";
 export { provisionNewUser, createProvisioningHandler, } from "./provision-users.mjs";
+export { getPlanById, getPlanGroupById, createGetPlanGroupByIdHandler, getGroupPlans, createGetGroupPlansHandler, subscribe, createSubscribeHandler, unsubscribe, createUnsubscribeHandler, upgrade, createUpgradeHandler, } from "./plans.mjs";

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

@@ -8,11 +8,17 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { createHandler } from "../utils/base-handler.mjs";
+import { getPlanById } from "./plans.mjs";
+function hasProductWithExternalId(pp) {
+    if (!pp.product) {
+        throw new Error(`Plan product ${pp.id} is missing nested product data`);
+    }
+    return !!pp.product.externalId;
+}
 /**
  * Generate default values for missing order fields
  */
 function generateOrderDefaults(config, options = {}) {
-    var _a;
     const { defaultDurationDays = 365 } = options;
     const startDate = config.startDate || new Date().toISOString().split("T")[0];
     const endDate = config.endDate ||
@@ -22,20 +28,31 @@ function generateOrderDefaults(config, options = {}) {
     const name = config.name || "Subscription Order";
     const description = config.description || "Annual subscription";
     const currency = config.currency || "USD";
-    const orderLines = ((_a = config.orderLines) === null || _a === void 0 ? void 0 : _a.map(line => ({
-        agentExternalId: line.agentExternalId,
-        name: line.name || name,
-        description: line.description || description,
-    }))) || [{
-            agentExternalId: config.agentExternalId,
-            name,
-            description,
-        }];
+    // defensive guard
+    if (!config.orderLines && !config.planId && !config.agentExternalId) {
+        throw new Error("Either orderLines, planId, or agentExternalId must be provided");
+    }
+    const orderLines = config.orderLines
+        ? config.orderLines.map(line => {
+            var _a;
+            return ({
+                agentExternalId: line.agentExternalId,
+                name: line.name || name,
+                description: line.description || description,
+                planProductId: (_a = line.planProductId) !== null && _a !== void 0 ? _a : undefined,
+            });
+        })
+        : [{
+                agentExternalId: config.agentExternalId,
+                name,
+                description,
+            }];
     return {
         customerId: config.customerId,
         customerExternalId: config.customerExternalId,
         billingContactId: config.billingContactId,
         agentExternalId: config.agentExternalId,
+        planId: config.planId,
         name,
         description,
         startDate,
@@ -64,8 +81,12 @@ function createAndActivateOrder(client, config, autoActivate) {
                     orderLine.name = line.name;
                 if (line.description)
                     orderLine.description = line.description;
+                // planProductId is not in the create orders api spec - this is functioning but greptile will complain
+                if (line.planProductId)
+                    orderLine.planProductId = line.planProductId;
                 return orderLine;
             }),
+            planId: config.planId,
         });
         if (!order.id) {
             throw new Error("Order created but missing ID");
@@ -172,18 +193,32 @@ export function createOrder(client_1, config_1) {
  */
 export function createOrdersHandler(helperOptions) {
     return createHandler((client, body) => __awaiter(this, void 0, void 0, function* () {
-        var _a, _b;
-        if (!body.customerId) {
-            throw new Error("customerId is required");
-        }
+        var _a, _b, _c;
         if (!body.customerExternalId) {
             throw new Error("customerExternalId is required");
         }
-        if (!body.agentExternalId) {
-            throw new Error("agentExternalId is required");
+        if (!body.agentExternalId && !body.planId) {
+            throw new Error("agentExternalId or planId are required");
         }
         const orderOptions = Object.assign(Object.assign({}, helperOptions), { autoActivate: (_b = (_a = body.autoActivate) !== null && _a !== void 0 ? _a : helperOptions === null || helperOptions === void 0 ? void 0 : helperOptions.autoActivate) !== null && _b !== void 0 ? _b : true });
+        if (body.planId) {
+            const plan = yield getPlanById(client, body.planId);
+            if (!((_c = plan.planProducts) === null || _c === void 0 ? void 0 : _c.length)) {
+                throw new Error(`Plan ${body.planId} has no products`);
+            }
+            body.orderLines = plan.planProducts
+                .filter(hasProductWithExternalId)
+                .map((pp) => ({
+                agentExternalId: pp.product.externalId,
+                name: pp.product.name,
+                description: pp.product.description,
+                planProductId: pp.id,
+            }));
+            if (body.orderLines.length === 0) {
+                throw new Error(`Plan ${body.planId} has no products with externalId`);
+            }
+        }
         const order = yield createOrderWithDefaults(client, body, orderOptions);
         return { success: true, data: order };
-    }), { requiredFields: ['customerId', 'customerExternalId', 'agentExternalId'] });
+    }), { requiredFields: ['customerExternalId'] });
 }