@usehercules/sdk 1.2.0 → 1.4.0

package/resources/beta/pay/products/products.d.ts

@@ -0,0 +1,183 @@
+import { APIResource } from "../../../../core/resource.js";
+import * as EntitlementsAPI from "./entitlements.js";
+import { EntitlementAttachParams, EntitlementListParams, EntitlementRemoveParams, Entitlements, ProductEntitlement, ProductEntitlementsCursorIDPage } from "./entitlements.js";
+import * as VariantsAPI from "./variants.js";
+import { Variant, VariantArchiveParams, VariantCreateParams, VariantGetParams, VariantListParams, VariantUpdateParams, Variants, VariantsCursorIDPage } from "./variants.js";
+import { APIPromise } from "../../../../core/api-promise.js";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../../core/pagination.js";
+import { RequestOptions } from "../../../../internal/request-options.js";
+export declare class Products extends APIResource {
+    entitlements: EntitlementsAPI.Entitlements;
+    variants: VariantsAPI.Variants;
+    /**
+     * Creates a new subscription product with a recurring price. Common examples
+     * include Free, Pro, Business, or Teams tiers. After creating a product, attach
+     * entitlements to define which features customers on this product can access.
+     */
+    create(body: ProductCreateParams, options?: RequestOptions): APIPromise<Product>;
+    /**
+     * Updates an existing product. Use this to modify the product name, description,
+     * or active status. Pricing cannot be changed after creation—create a new product
+     * instead.
+     */
+    update(productID: string, body?: ProductUpdateParams | null | undefined, options?: RequestOptions): APIPromise<Product>;
+    /**
+     * Retrieves a paginated list of subscription products. Products define the pricing
+     * and billing intervals for subscriptions. Each product can have entitlements
+     * attached that grant features to subscribed customers.
+     */
+    list(query?: ProductListParams | null | undefined, options?: RequestOptions): PagePromise<ProductsCursorIDPage, Product>;
+    /**
+     * Archives a product, preventing new subscriptions. Existing subscriptions remain
+     * active. Use this instead of deletion to preserve subscription history.
+     */
+    archive(productID: string, options?: RequestOptions): APIPromise<Product>;
+    /**
+     * Retrieves a product by ID. Returns the product object including pricing details
+     * and status.
+     */
+    get(productID: string, options?: RequestOptions): APIPromise<Product>;
+}
+export type ProductsCursorIDPage = CursorIDPage<Product>;
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach entitlements to a product to grant features to
+ * customers.
+ */
+export interface Product {
+    /**
+     * Unique identifier for the price
+     */
+    id: string;
+    /**
+     * Whether the product is available for new purchases
+     */
+    active: boolean;
+    /**
+     * Timestamp when the product was created
+     */
+    created: string;
+    /**
+     * Display name for the product (e.g., Pro, Business, Teams)
+     */
+    name: string;
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    default_price?: Product.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+}
+export declare namespace Product {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the price
+         */
+        id: string;
+        /**
+         * How to handle the billing cycle when switching plans. 'now' resets to current
+         * time, 'unchanged' keeps the original anchor. Null for one-time prices.
+         */
+        billing_cycle_anchor: 'now' | 'unchanged' | null;
+        /**
+         * Three-letter ISO currency code (e.g., usd, eur)
+         */
+        currency: string;
+        /**
+         * Billing frequency for recurring prices: day, week, month, or year. Null for
+         * one-time prices.
+         */
+        interval: 'day' | 'week' | 'month' | 'year' | null;
+        /**
+         * Number of intervals between billings for recurring prices. Null for one-time
+         * prices.
+         */
+        interval_count: number | null;
+        /**
+         * How to handle prorations when switching plans. 'default' creates prorations,
+         * 'none' disables them. Null for one-time prices.
+         */
+        proration_behavior: 'default' | 'none' | null;
+        /**
+         * When to calculate proration. 'now' uses current time, 'start_of_period' uses the
+         * billing period start. Null for one-time prices or to use Stripe's default.
+         */
+        proration_date: 'now' | 'start_of_period' | null;
+        /**
+         * Price type: one_time for single purchases, recurring for subscriptions
+         */
+        type: 'one_time' | 'recurring';
+        /**
+         * Price amount in the smallest currency unit (e.g., cents)
+         */
+        unit_amount: number | null;
+    }
+}
+export interface ProductCreateParams {
+    /**
+     * Display name for the product (e.g., Pro, Business, Teams)
+     */
+    name: string;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). Use 0 for free
+     * products.
+     */
+    unit_amount: number;
+    /**
+     * Optional custom ID for the product. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string;
+    /**
+     * Billing frequency for recurring prices: day, week, month, or year. Required for
+     * recurring type, ignored for one_time.
+     */
+    interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Number of intervals between billings for recurring prices. Required for
+     * recurring type, ignored for one_time.
+     */
+    interval_count?: number;
+    /**
+     * Price type: one_time for single purchases, recurring for subscriptions
+     */
+    type?: 'one_time' | 'recurring';
+}
+export interface ProductUpdateParams {
+    /**
+     * Whether the product is available for new subscriptions
+     */
+    active?: boolean;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string;
+    /**
+     * Display name for the product
+     */
+    name?: string;
+}
+export interface ProductListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: 'true' | 'false';
+}
+export declare namespace Products {
+    export { type Product as Product, type ProductsCursorIDPage as ProductsCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
+    export { Entitlements as Entitlements, type ProductEntitlement as ProductEntitlement, type ProductEntitlementsCursorIDPage as ProductEntitlementsCursorIDPage, type EntitlementListParams as EntitlementListParams, type EntitlementAttachParams as EntitlementAttachParams, type EntitlementRemoveParams as EntitlementRemoveParams, };
+    export { Variants as Variants, type Variant as Variant, type VariantsCursorIDPage as VariantsCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantArchiveParams as VariantArchiveParams, type VariantGetParams as VariantGetParams, };
+}
+//# sourceMappingURL=products.d.ts.map

package/resources/beta/pay/products/products.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.d.ts","sourceRoot":"","sources":["../../../../src/resources/beta/pay/products/products.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EACL,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,+BAA+B,EAChC;OACM,KAAK,WAAW;OAChB,EACL,OAAO,EACP,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,oBAAoB,EACrB;OACM,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC,YAAY,EAAE,eAAe,CAAC,YAAY,CAAkD;IAC5F,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAA0C;IAExE;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;OAIG;IACH,MAAM,CACJ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,OAAO,CAAC;IAItB;;;;OAIG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAI7C;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIzE;;;OAGG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGtE;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,oBAAoB,EAAE,KAAK,GAAG,WAAW,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;QAEnD;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,kBAAkB,EAAE,SAAS,GAAG,MAAM,GAAG,IAAI,CAAC;QAE9C;;;WAGG;QACH,cAAc,EAAE,KAAK,GAAG,iBAAiB,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAE7C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AAKD,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,YAAY,IAAI,YAAY,EAC5B,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/beta/pay/products/products.js

@@ -0,0 +1,61 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Products = void 0;
+const tslib_1 = require("../../../../internal/tslib.js");
+const resource_1 = require("../../../../core/resource.js");
+const EntitlementsAPI = tslib_1.__importStar(require("./entitlements.js"));
+const entitlements_1 = require("./entitlements.js");
+const VariantsAPI = tslib_1.__importStar(require("./variants.js"));
+const variants_1 = require("./variants.js");
+const pagination_1 = require("../../../../core/pagination.js");
+const path_1 = require("../../../../internal/utils/path.js");
+class Products extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
+        this.variants = new VariantsAPI.Variants(this._client);
+    }
+    /**
+     * Creates a new subscription product with a recurring price. Common examples
+     * include Free, Pro, Business, or Teams tiers. After creating a product, attach
+     * entitlements to define which features customers on this product can access.
+     */
+    create(body, options) {
+        return this._client.post('/v1/pay/products', { body, ...options });
+    }
+    /**
+     * Updates an existing product. Use this to modify the product name, description,
+     * or active status. Pricing cannot be changed after creation—create a new product
+     * instead.
+     */
+    update(productID, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/v1/pay/products/${productID}`, { body, ...options });
+    }
+    /**
+     * Retrieves a paginated list of subscription products. Products define the pricing
+     * and billing intervals for subscriptions. Each product can have entitlements
+     * attached that grant features to subscribed customers.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/pay/products', (pagination_1.CursorIDPage), { query, ...options });
+    }
+    /**
+     * Archives a product, preventing new subscriptions. Existing subscriptions remain
+     * active. Use this instead of deletion to preserve subscription history.
+     */
+    archive(productID, options) {
+        return this._client.delete((0, path_1.path) `/v1/pay/products/${productID}`, options);
+    }
+    /**
+     * Retrieves a product by ID. Returns the product object including pricing details
+     * and status.
+     */
+    get(productID, options) {
+        return this._client.get((0, path_1.path) `/v1/pay/products/${productID}`, options);
+    }
+}
+exports.Products = Products;
+Products.Entitlements = entitlements_1.Entitlements;
+Products.Variants = variants_1.Variants;
+//# sourceMappingURL=products.js.map

package/resources/beta/pay/products/products.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.js","sourceRoot":"","sources":["../../../../src/resources/beta/pay/products/products.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,2DAAwD;AACxD,2EAAkD;AAClD,oDAOwB;AACxB,mEAA0C;AAC1C,4CASoB;AAEpB,+DAAiG;AAEjG,6DAAuD;AAEvD,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmD1E,CAAC;IAjDC;;;;OAIG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,SAAiB,EACjB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,oBAAoB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,yBAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AArDD,4BAqDC;AAuKD,QAAQ,CAAC,YAAY,GAAG,2BAAY,CAAC;AACrC,QAAQ,CAAC,QAAQ,GAAG,mBAAQ,CAAC"}

package/resources/beta/pay/products/products.mjs

@@ -0,0 +1,56 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../../core/resource.mjs";
+import * as EntitlementsAPI from "./entitlements.mjs";
+import { Entitlements, } from "./entitlements.mjs";
+import * as VariantsAPI from "./variants.mjs";
+import { Variants, } from "./variants.mjs";
+import { CursorIDPage } from "../../../../core/pagination.mjs";
+import { path } from "../../../../internal/utils/path.mjs";
+export class Products extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.entitlements = new EntitlementsAPI.Entitlements(this._client);
+        this.variants = new VariantsAPI.Variants(this._client);
+    }
+    /**
+     * Creates a new subscription product with a recurring price. Common examples
+     * include Free, Pro, Business, or Teams tiers. After creating a product, attach
+     * entitlements to define which features customers on this product can access.
+     */
+    create(body, options) {
+        return this._client.post('/v1/pay/products', { body, ...options });
+    }
+    /**
+     * Updates an existing product. Use this to modify the product name, description,
+     * or active status. Pricing cannot be changed after creation—create a new product
+     * instead.
+     */
+    update(productID, body = {}, options) {
+        return this._client.patch(path `/v1/pay/products/${productID}`, { body, ...options });
+    }
+    /**
+     * Retrieves a paginated list of subscription products. Products define the pricing
+     * and billing intervals for subscriptions. Each product can have entitlements
+     * attached that grant features to subscribed customers.
+     */
+    list(query = {}, options) {
+        return this._client.getAPIList('/v1/pay/products', (CursorIDPage), { query, ...options });
+    }
+    /**
+     * Archives a product, preventing new subscriptions. Existing subscriptions remain
+     * active. Use this instead of deletion to preserve subscription history.
+     */
+    archive(productID, options) {
+        return this._client.delete(path `/v1/pay/products/${productID}`, options);
+    }
+    /**
+     * Retrieves a product by ID. Returns the product object including pricing details
+     * and status.
+     */
+    get(productID, options) {
+        return this._client.get(path `/v1/pay/products/${productID}`, options);
+    }
+}
+Products.Entitlements = Entitlements;
+Products.Variants = Variants;
+//# sourceMappingURL=products.mjs.map

package/resources/beta/pay/products/products.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"products.mjs","sourceRoot":"","sources":["../../../../src/resources/beta/pay/products/products.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EAIL,YAAY,GAGb;OACM,KAAK,WAAW;OAChB,EAOL,QAAQ,GAET;OAEM,EAAE,YAAY,EAAwC;OAEtD,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,iBAAY,GAAiC,IAAI,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5F,aAAQ,GAAyB,IAAI,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAmD1E,CAAC;IAjDC;;;;OAIG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,MAAM,CACJ,SAAiB,EACjB,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;;;OAIG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAA,YAAqB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnG,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,SAAiB,EAAE,OAAwB;QACjD,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,SAAiB,EAAE,OAAwB;QAC7C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;CACF;AAuKD,QAAQ,CAAC,YAAY,GAAG,YAAY,CAAC;AACrC,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC"}

package/resources/beta/pay/products/variants.d.mts

@@ -0,0 +1,206 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import { APIPromise } from "../../../../core/api-promise.mjs";
+import { CursorIDPage, type CursorIDPageParams, PagePromise } from "../../../../core/pagination.mjs";
+import { RequestOptions } from "../../../../internal/request-options.mjs";
+export declare class Variants extends APIResource {
+    /**
+     * Creates a new variant with pricing for a product. Use variants to offer multiple
+     * pricing tiers or configurations (e.g., Basic at $10/month, Pro at $25/month). A
+     * Stripe Price is automatically created.
+     */
+    create(productID: string, body: VariantCreateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Updates an existing variant. Use this to modify the name, description, or active
+     * status. Pricing cannot be changed after creation—create a new variant instead.
+     */
+    update(variantID: string, params: VariantUpdateParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Retrieves all variants for a product. Variants represent different pricing tiers
+     * or configurations (e.g., Basic, Pro, Enterprise) within a single product.
+     */
+    list(productID: string, query?: VariantListParams | null | undefined, options?: RequestOptions): PagePromise<VariantsCursorIDPage, Variant>;
+    /**
+     * Archives a variant, preventing new subscriptions. The associated Stripe Price is
+     * also archived. Existing subscriptions remain active.
+     */
+    archive(variantID: string, params: VariantArchiveParams, options?: RequestOptions): APIPromise<Variant>;
+    /**
+     * Retrieves a variant by ID. Returns the variant object including pricing details
+     * and status.
+     */
+    get(variantID: string, params: VariantGetParams, options?: RequestOptions): APIPromise<Variant>;
+}
+export type VariantsCursorIDPage = CursorIDPage<Variant>;
+/**
+ * A product variant representing a specific tier or configuration. Each variant
+ * has its own pricing. Variants allow a single product to have multiple pricing
+ * options (e.g., Basic, Pro, Enterprise tiers).
+ */
+export interface Variant {
+    /**
+     * Unique identifier for the price
+     */
+    id: string;
+    /**
+     * Whether the variant is available for new purchases
+     */
+    active: boolean;
+    /**
+     * Timestamp when the variant was created
+     */
+    created: string;
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    default_price?: Variant.DefaultPrice | null;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string | null;
+}
+export declare namespace Variant {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the price
+         */
+        id: string;
+        /**
+         * How to handle the billing cycle when switching plans. 'now' resets to current
+         * time, 'unchanged' keeps the original anchor. Null for one-time prices.
+         */
+        billing_cycle_anchor: 'now' | 'unchanged' | null;
+        /**
+         * Three-letter ISO currency code (e.g., usd, eur)
+         */
+        currency: string;
+        /**
+         * Billing frequency for recurring prices: day, week, month, or year. Null for
+         * one-time prices.
+         */
+        interval: 'day' | 'week' | 'month' | 'year' | null;
+        /**
+         * Number of intervals between billings for recurring prices. Null for one-time
+         * prices.
+         */
+        interval_count: number | null;
+        /**
+         * How to handle prorations when switching plans. 'default' creates prorations,
+         * 'none' disables them. Null for one-time prices.
+         */
+        proration_behavior: 'default' | 'none' | null;
+        /**
+         * When to calculate proration. 'now' uses current time, 'start_of_period' uses the
+         * billing period start. Null for one-time prices or to use Stripe's default.
+         */
+        proration_date: 'now' | 'start_of_period' | null;
+        /**
+         * Price type: one_time for single purchases, recurring for subscriptions
+         */
+        type: 'one_time' | 'recurring';
+        /**
+         * Price amount in the smallest currency unit (e.g., cents)
+         */
+        unit_amount: number | null;
+    }
+}
+export interface VariantCreateParams {
+    /**
+     * Display name for the variant (e.g., Basic, Standard, Premium)
+     */
+    name: string;
+    /**
+     * Price amount in the smallest currency unit (e.g., cents). Use 0 for free
+     * variants.
+     */
+    unit_amount: number;
+    /**
+     * Optional custom ID for the variant. If not provided, one will be generated.
+     */
+    id?: string;
+    /**
+     * Default billing cycle anchor behavior when switching to this price. 'now' resets
+     * to current time, 'unchanged' keeps original anchor. Only applies to recurring
+     * prices.
+     */
+    billing_cycle_anchor?: 'now' | 'unchanged';
+    /**
+     * Three-letter ISO currency code
+     */
+    currency?: string;
+    /**
+     * Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Billing frequency for recurring prices: day, week, month, or year. Required for
+     * recurring type, ignored for one_time.
+     */
+    interval?: 'day' | 'week' | 'month' | 'year';
+    /**
+     * Number of intervals between billings for recurring prices. Required for
+     * recurring type, ignored for one_time.
+     */
+    interval_count?: number;
+    /**
+     * Default proration behavior when switching to this price. 'default' creates
+     * prorations, 'none' disables them. Only applies to recurring prices.
+     */
+    proration_behavior?: 'default' | 'none';
+    /**
+     * Default proration date calculation when switching to this price. 'now' uses
+     * current time, 'start_of_period' uses billing period start. Only applies to
+     * recurring prices.
+     */
+    proration_date?: 'now' | 'start_of_period';
+    /**
+     * Price type: one_time for single purchases, recurring for subscriptions
+     */
+    type?: 'one_time' | 'recurring';
+}
+export interface VariantUpdateParams {
+    /**
+     * Path param: The unique identifier of the product
+     */
+    product_id: string;
+    /**
+     * Body param: Whether the variant is available for new purchases
+     */
+    active?: boolean;
+    /**
+     * Body param: Detailed description of what this variant includes
+     */
+    description?: string;
+    /**
+     * Body param: Display name for the variant
+     */
+    name?: string;
+}
+export interface VariantListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: 'true' | 'false';
+}
+export interface VariantArchiveParams {
+    /**
+     * The unique identifier of the product
+     */
+    product_id: string;
+}
+export interface VariantGetParams {
+    /**
+     * The unique identifier of the product
+     */
+    product_id: string;
+}
+export declare namespace Variants {
+    export { type Variant as Variant, type VariantsCursorIDPage as VariantsCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantArchiveParams as VariantArchiveParams, type VariantGetParams as VariantGetParams, };
+}
+//# sourceMappingURL=variants.d.mts.map

package/resources/beta/pay/products/variants.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variants.d.mts","sourceRoot":"","sources":["../../../../src/resources/beta/pay/products/variants.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE;OACtD,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;OAIG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;OAGG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAQrG;;;OAGG;IACH,IAAI,CACF,SAAS,EAAE,MAAM,EACjB,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC;IAO7C;;;OAGG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAKvG;;;OAGG;IACH,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAIhG;AAED,MAAM,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;;WAGG;QACH,oBAAoB,EAAE,KAAK,GAAG,WAAW,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;QAEnD;;;WAGG;QACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;;WAGG;QACH,kBAAkB,EAAE,SAAS,GAAG,MAAM,GAAG,IAAI,CAAC;QAE9C;;;WAGG;QACH,cAAc,EAAE,KAAK,GAAG,iBAAiB,GAAG,IAAI,CAAC;QAEjD;;WAEG;QACH,IAAI,EAAE,UAAU,GAAG,WAAW,CAAC;QAE/B;;WAEG;QACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAE7C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,SAAS,GAAG,MAAM,CAAC;IAExC;;;;OAIG;IACH,cAAc,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC;IAE3C;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}