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

package/README.md

@@ -142,7 +142,7 @@ For maximum convenience, you can use OpenTelemetry auto-instrumentation to autom
 ``` typescript
 // Import and call auto-instrumentation before importing instrumented libraries
 import { paidAutoInstrument } from "@paid-ai/paid-node/tracing";
-paidAutoInstrument()
+await paidAutoInstrument()
 
 import openai from "openai";
 
@@ -192,7 +192,7 @@ import openai from "openai";
 
 // If your module management is too complex and the previous approach didn't work
 // you can provide libraries directly
-paidAutoInstrument({ openai })
+await paidAutoInstrument({ openai })
 ```
 
 
@@ -310,7 +310,7 @@ async function main() {
 
     await trace({
         externalCustomerId: "<your_external_customer_id>",
-        externalAgentId: "<your_external_agent_id>"
+        externalProductId: "<your_external_product_id>"
     }, async () => {
         // ...do some work...
         signal("<your_signal_name>", false, {
@@ -367,7 +367,7 @@ async function main() {
 
     await trace({
         externalCustomerId: "<your_external_customer_id>",
-        externalAgentId: "<your_external_agent_id>"
+        externalProductId: "<your_external_product_id>"
     }, async () => {
         // ...do some work...
         signal("<your_signal_name>", false, {

package/dist/cjs/Client.js

@@ -50,8 +50,8 @@ class PaidClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "@paid-ai/paid-node",
-                "X-Fern-SDK-Version": "1.0.1-alpha1",
-                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha1",
+                "X-Fern-SDK-Version": "1.0.1-alpha5",
+                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha5",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/index.d.ts

@@ -9,6 +9,7 @@ export * from "./orders/client/requests/index.js";
 export * as orders from "./orders/index.js";
 export * from "./plans/client/requests/index.js";
 export * as plans from "./plans/index.js";
+export * from "./plans/types/index.js";
 export * from "./products/client/requests/index.js";
 export * as products from "./products/index.js";
 export * from "./traces/client/requests/index.js";

package/dist/cjs/api/resources/index.js

@@ -48,6 +48,7 @@ __exportStar(require("./orders/client/requests/index.js"), exports);
 exports.orders = __importStar(require("./orders/index.js"));
 __exportStar(require("./plans/client/requests/index.js"), exports);
 exports.plans = __importStar(require("./plans/index.js"));
+__exportStar(require("./plans/types/index.js"), exports);
 __exportStar(require("./products/client/requests/index.js"), exports);
 exports.products = __importStar(require("./products/index.js"));
 __exportStar(require("./traces/client/requests/index.js"), exports);

package/dist/cjs/api/resources/plans/client/Client.d.ts

@@ -10,6 +10,23 @@ export declare namespace Plans {
 export declare class Plans {
     protected readonly _options: Plans.Options;
     constructor(_options?: Plans.Options);
+    /**
+     * Retrieves the currently active plan subscription for a customer by their external ID. Returns the plan details and subscription information.
+     *
+     * @param {Paid.PlansGetCurrentRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.getCurrent({
+     *         customerExternalId: "customerExternalId"
+     *     })
+     */
+    getCurrent(request: Paid.PlansGetCurrentRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.PlansGetCurrentResponse>;
+    private __getCurrent;
     /**
      * @param {string} planId - The ID of the plan
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -42,6 +59,62 @@ export declare class Plans {
      */
     getUsage(planId: string, request: Paid.PlansGetUsageRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.UsageSummariesResponse>;
     private __getUsage;
+    /**
+     * Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.
+     *
+     * @param {string} planId - The ID of the plan
+     * @param {Paid.PlansSubscribeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.subscribe("planId", {
+     *         customerExternalId: "customerExternalId",
+     *         currency: "currency"
+     *     })
+     */
+    subscribe(planId: string, request: Paid.PlansSubscribeRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.Order>;
+    private __subscribe;
+    /**
+     * Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.
+     *
+     * @param {string} planId - The ID of the plan
+     * @param {Paid.PlansUnsubscribeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.unsubscribe("planId", {
+     *         customerExternalId: "customerExternalId"
+     *     })
+     */
+    unsubscribe(planId: string, request: Paid.PlansUnsubscribeRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.CancelRenewalResponse>;
+    private __unsubscribe;
+    /**
+     * 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.
+     *
+     * @param {Paid.PlansUpgradeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.upgrade({
+     *         customerExternalId: "customerExternalId",
+     *         oldPlanId: "oldPlanId",
+     *         newPlanId: "newPlanId"
+     *     })
+     */
+    upgrade(request: Paid.PlansUpgradeRequest, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.ProrationUpgradeResponse>;
+    private __upgrade;
     /**
      * @param {string} planGroupId - The ID of the plan group
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -55,6 +128,8 @@ export declare class Plans {
     getGroupById(planGroupId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.PlanGroup>;
     private __getGroupById;
     /**
+     * Retrieves all plans in a plan group with their features (product-attribute pairs)
+     *
      * @param {string} planGroupId - The ID of the plan group
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/plans/client/Client.js

@@ -53,6 +53,76 @@ class Plans {
     constructor(_options = {}) {
         this._options = _options;
     }
+    /**
+     * Retrieves the currently active plan subscription for a customer by their external ID. Returns the plan details and subscription information.
+     *
+     * @param {Paid.PlansGetCurrentRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.getCurrent({
+     *         customerExternalId: "customerExternalId"
+     *     })
+     */
+    getCurrent(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getCurrent(request, requestOptions));
+    }
+    __getCurrent(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { customerExternalId } = request;
+            const _queryParams = {};
+            _queryParams.customerExternalId = customerExternalId;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Production, "plans/current"),
+                method: "GET",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /plans/current.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * @param {string} planId - The ID of the plan
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -198,6 +268,224 @@ class Plans {
             }
         });
     }
+    /**
+     * Creates a new order for a customer subscribing to a plan. The order will be created with the plan's products and pricing attributes.
+     *
+     * @param {string} planId - The ID of the plan
+     * @param {Paid.PlansSubscribeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.subscribe("planId", {
+     *         customerExternalId: "customerExternalId",
+     *         currency: "currency"
+     *     })
+     */
+    subscribe(planId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__subscribe(planId, request, requestOptions));
+    }
+    __subscribe(planId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { customerExternalId, currency } = request;
+            const _queryParams = {};
+            _queryParams.customerExternalId = customerExternalId;
+            _queryParams.currency = currency;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Production, `plans/${core.url.encodePathParam(planId)}/subscribe`),
+                method: "POST",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /plans/{planId}/subscribe.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * Cancels the renewal of an active order for a customer's plan subscription. The order will remain active until the cancellation date.
+     *
+     * @param {string} planId - The ID of the plan
+     * @param {Paid.PlansUnsubscribeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.unsubscribe("planId", {
+     *         customerExternalId: "customerExternalId"
+     *     })
+     */
+    unsubscribe(planId, request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__unsubscribe(planId, request, requestOptions));
+    }
+    __unsubscribe(planId, request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { customerExternalId } = request;
+            const _queryParams = {};
+            _queryParams.customerExternalId = customerExternalId;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Production, `plans/${core.url.encodePathParam(planId)}/unsubscribe`),
+                method: "POST",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /plans/{planId}/unsubscribe.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * 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.
+     *
+     * @param {Paid.PlansUpgradeRequest} request
+     * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Paid.BadRequestError}
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.upgrade({
+     *         customerExternalId: "customerExternalId",
+     *         oldPlanId: "oldPlanId",
+     *         newPlanId: "newPlanId"
+     *     })
+     */
+    upgrade(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__upgrade(request, requestOptions));
+    }
+    __upgrade(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            const { customerExternalId, oldPlanId, newPlanId } = request;
+            const _queryParams = {};
+            _queryParams.customerExternalId = customerExternalId;
+            _queryParams.oldPlanId = oldPlanId;
+            _queryParams.newPlanId = newPlanId;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.PaidEnvironment.Production, "plans/upgrade"),
+                method: "POST",
+                headers: _headers,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new Paid.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new Paid.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new Paid.NotFoundError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.PaidError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.PaidError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling POST /plans/upgrade.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     /**
      * @param {string} planGroupId - The ID of the plan group
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
@@ -259,6 +547,8 @@ class Plans {
         });
     }
     /**
+     * Retrieves all plans in a plan group with their features (product-attribute pairs)
+     *
      * @param {string} planGroupId - The ID of the plan group
      * @param {Plans.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/plans/client/requests/PlansGetCurrentRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customerExternalId"
+ *     }
+ *
+ * @example
+ *     {
+ *         customerExternalId: "customerExternalId"
+ *     }
+ */
+export interface PlansGetCurrentRequest {
+    /** The external ID of the customer */
+    customerExternalId: string;
+}

package/dist/cjs/api/resources/plans/client/requests/PlansGetCurrentRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/plans/client/requests/PlansSubscribeRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customerExternalId",
+ *         currency: "currency"
+ *     }
+ */
+export interface PlansSubscribeRequest {
+    /** The external ID of the customer */
+    customerExternalId: string;
+    /** The currency code for the order (e.g., "USD", "EUR") */
+    currency: string;
+}

package/dist/cjs/api/resources/plans/client/requests/PlansSubscribeRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/plans/client/requests/PlansUnsubscribeRequest.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customerExternalId"
+ *     }
+ */
+export interface PlansUnsubscribeRequest {
+    /** The external ID of the customer */
+    customerExternalId: string;
+}

package/dist/cjs/api/resources/plans/client/requests/PlansUnsubscribeRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/plans/client/requests/PlansUpgradeRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @example
+ *     {
+ *         customerExternalId: "customerExternalId",
+ *         oldPlanId: "oldPlanId",
+ *         newPlanId: "newPlanId"
+ *     }
+ */
+export interface PlansUpgradeRequest {
+    /** The external ID of the customer */
+    customerExternalId: string;
+    /** The ID of the current plan */
+    oldPlanId: string;
+    /** The ID of the plan to upgrade to */
+    newPlanId: string;
+}

package/dist/cjs/api/resources/plans/client/requests/PlansUpgradeRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was auto-generated by Fern from our API Definition.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/api/resources/plans/client/requests/index.d.ts

@@ -1 +1,5 @@
+export type { PlansGetCurrentRequest } from "./PlansGetCurrentRequest.js";
 export type { PlansGetUsageRequest } from "./PlansGetUsageRequest.js";
+export type { PlansSubscribeRequest } from "./PlansSubscribeRequest.js";
+export type { PlansUnsubscribeRequest } from "./PlansUnsubscribeRequest.js";
+export type { PlansUpgradeRequest } from "./PlansUpgradeRequest.js";

package/dist/cjs/api/resources/plans/index.d.ts

@@ -1 +1,2 @@
 export * from "./client/index.js";
+export * from "./types/index.js";

package/dist/cjs/api/resources/plans/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client/index.js"), exports);
+__exportStar(require("./types/index.js"), exports);

package/dist/cjs/api/resources/plans/types/PlansGetCurrentResponse.d.ts

@@ -0,0 +1,83 @@
+import type * as Paid from "../../../index.js";
+export interface PlansGetCurrentResponse {
+    /** The plan details, or null if the customer has no active plan */
+    plan?: PlansGetCurrentResponse.Plan;
+    /** The subscription details, or null if the customer has no active plan */
+    subscription?: PlansGetCurrentResponse.Subscription;
+}
+export declare namespace PlansGetCurrentResponse {
+    /**
+     * The plan details, or null if the customer has no active plan
+     */
+    interface Plan {
+        /** The unique identifier of the plan */
+        id: string;
+        /** The name of the plan */
+        name: string;
+        /** The description of the plan */
+        description?: string;
+        /** The type of plan */
+        type: Plan.Type;
+        pricing: Paid.PlanPricing;
+        /** The plan group ID this plan belongs to */
+        planGroupId: string;
+        /** The ID of the next plan in the sequence */
+        nextPlanId?: string;
+        /** The ID of the previous plan in the sequence */
+        prevPlanId?: string;
+        /** The features (product-attribute pairs) included in this plan with usage and limits */
+        features: Plan.Features.Item[];
+    }
+    namespace Plan {
+        /** The type of plan */
+        const Type: {
+            readonly Flat: "flat";
+            readonly Usage: "usage";
+            readonly Credit: "credit";
+        };
+        type Type = (typeof Type)[keyof typeof Type];
+        type Features = Features.Item[];
+        namespace Features {
+            interface Item {
+                /** The name of the product */
+                productName: string;
+                /** The name of the product attribute */
+                attributeName: string;
+                /** The pricing configuration for this feature */
+                pricing: Record<string, unknown>;
+                /** Current usage and limits for this feature */
+                usage: Item.Usage;
+            }
+            namespace Item {
+                /**
+                 * Current usage and limits for this feature
+                 */
+                interface Usage {
+                    /** The event name used to track usage for this feature */
+                    eventName?: string;
+                    /** The current usage quantity for this feature on the order */
+                    currentUsage: number;
+                    /** The usage limit for this feature (null if unlimited) */
+                    limit?: number;
+                    /** Whether this feature has unlimited usage */
+                    isUnlimited: boolean;
+                }
+            }
+        }
+    }
+    /**
+     * The subscription details, or null if the customer has no active plan
+     */
+    interface Subscription {
+        /** The ID of the order */
+        orderId: string;
+        /** The display ID of the order */
+        orderDisplayId?: string;
+        /** The start date of the subscription */
+        startDate: string;
+        /** The end date of the subscription (null if ongoing) */
+        endDate?: string;
+        /** The total usage quantity across all features on this order */
+        totalUsage: number;
+    }
+}