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

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-alpha0",
-                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha0",
+                "X-Fern-SDK-Version": "1.0.1-alpha2",
+                "User-Agent": "@paid-ai/paid-node/1.0.1-alpha2",
                 "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/plans/client/Client.d.ts

@@ -42,6 +42,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.
@@ -54,5 +110,19 @@ 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.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.getGroupPlans("planGroupId")
+     */
+    getGroupPlans(planGroupId: string, requestOptions?: Plans.RequestOptions): core.HttpResponsePromise<Paid.PlanWithFeatures[]>;
+    private __getGroupPlans;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }

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

@@ -198,6 +198,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.
@@ -216,7 +434,69 @@ class Plans {
             var _a, _b, _c, _d, _e, _f, _g, _h;
             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/group/${core.url.encodePathParam(planGroupId)}`),
+                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/planGroup/${core.url.encodePathParam(planGroupId)}`),
+                method: "GET",
+                headers: _headers,
+                queryParameters: 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 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/planGroup/{planGroupId}.");
+                case "unknown":
+                    throw new errors.PaidError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
+    /**
+     * 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.
+     *
+     * @throws {@link Paid.ForbiddenError}
+     * @throws {@link Paid.NotFoundError}
+     *
+     * @example
+     *     await client.plans.getGroupPlans("planGroupId")
+     */
+    getGroupPlans(planGroupId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getGroupPlans(planGroupId, requestOptions));
+    }
+    __getGroupPlans(planGroupId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h;
+            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/planGroup/${core.url.encodePathParam(planGroupId)}/plans`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
@@ -249,7 +529,7 @@ class Plans {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /plans/group/{planGroupId}.");
+                    throw new errors.PaidTimeoutError("Timeout exceeded when calling GET /plans/planGroup/{planGroupId}/plans.");
                 case "unknown":
                     throw new errors.PaidError({
                         message: _response.error.errorMessage,

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,4 @@
 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/usage/client/Client.d.ts

@@ -33,15 +33,15 @@ export declare class Usage {
      *     await client.usage.usageRecordBulkV2({
      *         signals: [{
      *                 event_name: "emails_sent",
-     *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
-     *                 customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d"
+     *                 product_id: "prod_abc123def",
+     *                 customer_id: "cus_xyz789ghi"
      *             }, {
      *                 event_name: "emails_sent",
      *                 external_product_id: "acme-product",
      *                 external_customer_id: "acme-inc"
      *             }, {
      *                 event_name: "meeting_booked",
-     *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
+     *                 product_id: "prod_abc123def",
      *                 external_customer_id: "acme-inc",
      *                 data: {
      *                     "meeting_duration": 30,

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

@@ -120,15 +120,15 @@ class Usage {
      *     await client.usage.usageRecordBulkV2({
      *         signals: [{
      *                 event_name: "emails_sent",
-     *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
-     *                 customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d"
+     *                 product_id: "prod_abc123def",
+     *                 customer_id: "cus_xyz789ghi"
      *             }, {
      *                 event_name: "emails_sent",
      *                 external_product_id: "acme-product",
      *                 external_customer_id: "acme-inc"
      *             }, {
      *                 event_name: "meeting_booked",
-     *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
+     *                 product_id: "prod_abc123def",
      *                 external_customer_id: "acme-inc",
      *                 data: {
      *                     "meeting_duration": 30,

package/dist/cjs/api/resources/usage/client/requests/UsageRecordBulkV2Request.d.ts

@@ -4,15 +4,15 @@ import type * as Paid from "../../../../index.js";
  *     {
  *         signals: [{
  *                 event_name: "emails_sent",
- *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
- *                 customer_id: "7d0b6fce-d82a-433d-8315-c994f8f1d68d"
+ *                 product_id: "prod_abc123def",
+ *                 customer_id: "cus_xyz789ghi"
  *             }, {
  *                 event_name: "emails_sent",
  *                 external_product_id: "acme-product",
  *                 external_customer_id: "acme-inc"
  *             }, {
  *                 event_name: "meeting_booked",
- *                 product_id: "63fd642c-569d-44f9-8d67-5cf4944a16cc",
+ *                 product_id: "prod_abc123def",
  *                 external_customer_id: "acme-inc",
  *                 data: {
  *                     "meeting_duration": 30,

package/dist/cjs/api/types/Plan.d.ts

@@ -13,6 +13,10 @@ export interface Plan {
     name: string;
     /** The description of the plan */
     description?: string;
+    /** The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits) */
+    type: Plan.Type;
+    /** The pricing configuration for the plan */
+    pricing: Plan.Pricing;
     /** The ID of the next plan in the sequence */
     nextPlanId?: string;
     /** The ID of the previous plan in the sequence */
@@ -25,6 +29,35 @@ export interface Plan {
     planProducts?: Plan.PlanProducts.Item[];
 }
 export declare namespace Plan {
+    /** The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits) */
+    const Type: {
+        readonly Flat: "flat";
+        readonly Usage: "usage";
+        readonly Credit: "credit";
+    };
+    type Type = (typeof Type)[keyof typeof Type];
+    /**
+     * The pricing configuration for the plan
+     */
+    interface Pricing {
+        /** The currency code (e.g., "USD", "EUR") */
+        currency: string;
+        /** The fixed amount for flat plans (in smallest currency unit, e.g., cents) */
+        amount?: number;
+        /** The billing frequency for the plan */
+        billingFrequency: Pricing.BillingFrequency;
+        /** Custom billing frequency in months (if not using standard frequencies) */
+        billingFrequencyCustomMonths?: number;
+    }
+    namespace Pricing {
+        /** The billing frequency for the plan */
+        const BillingFrequency: {
+            readonly Monthly: "monthly";
+            readonly Quarterly: "quarterly";
+            readonly Annual: "annual";
+        };
+        type BillingFrequency = (typeof BillingFrequency)[keyof typeof BillingFrequency];
+    }
     type PlanProducts = PlanProducts.Item[];
     namespace PlanProducts {
         interface Item {

package/dist/cjs/api/types/Plan.js

@@ -1,3 +1,22 @@
 "use strict";
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plan = void 0;
+var Plan;
+(function (Plan) {
+    /** The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits) */
+    Plan.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 = Plan.Pricing || (Plan.Pricing = {}));
+})(Plan || (exports.Plan = Plan = {}));