@usehercules/sdk 1.7.0 → 1.8.0

package/resources/beta/commerce/products/products.d.mts

@@ -0,0 +1,967 @@
+import { APIResource } from "../../../../core/resource.mjs";
+import * as ResourcesAPI from "./resources.mjs";
+import { ResourceAttachParams, ResourceAttachResponse, ResourceListParams, ResourceListResponse, ResourceListResponsesCursorIDPage, ResourceRemoveParams, Resources } from "./resources.mjs";
+import * as VariantsAPI from "./variants.mjs";
+import { VariantArchiveParams, VariantArchiveResponse, VariantCreateParams, VariantCreateResponse, VariantGetParams, VariantGetResponse, VariantListParams, VariantListResponse, VariantListResponsesCursorIDPage, VariantUpdateParams, VariantUpdateResponse, Variants } from "./variants.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 Products extends APIResource {
+    resources: ResourcesAPI.Resources;
+    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
+     * resources to define which features or content customers on this product can
+     * access.
+     */
+    create(body: ProductCreateParams, options?: RequestOptions): APIPromise<ProductCreateResponse>;
+    /**
+     * 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<ProductUpdateResponse>;
+    /**
+     * Retrieves a paginated list of subscription products. Products define the pricing
+     * and billing intervals for subscriptions. Each product can have resources
+     * attached that grant access to features or content.
+     */
+    list(query?: ProductListParams | null | undefined, options?: RequestOptions): PagePromise<ProductListResponsesCursorIDPage, ProductListResponse>;
+    /**
+     * 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<ProductArchiveResponse>;
+    /**
+     * Retrieves a product by ID. Returns the product object including pricing details
+     * and status.
+     */
+    get(productID: string, options?: RequestOptions): APIPromise<ProductGetResponse>;
+}
+export type ProductListResponsesCursorIDPage = CursorIDPage<ProductListResponse>;
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach resources to a product to grant features to
+ * customers.
+ */
+export interface ProductCreateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    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?: ProductCreateResponse.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductCreateResponse.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string | null;
+    /**
+     * Resources attached to this product. Customers get access to these resources when
+     * they purchase the product.
+     */
+    resources?: Array<ProductCreateResponse.Resource>;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductCreateResponse {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        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;
+    }
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+    /**
+     * A resource that can be attached to products to grant access to customers.
+     * Resources represent monetizable content or features in your app.
+     */
+    interface Resource {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        id: string;
+        /**
+         * Whether the resource is active and grants access
+         */
+        active: boolean;
+        /**
+         * Timestamp when the resource was created
+         */
+        created: string;
+        /**
+         * Type of resource: custom_entitlement, file, content, course, or ticket
+         */
+        type: 'custom_entitlement' | 'file' | 'content' | 'course' | 'ticket';
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        custom_entitlement?: Resource.CustomEntitlement | null;
+    }
+    namespace Resource {
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        interface CustomEntitlement {
+            /**
+             * Unique identifier for the custom entitlement. Must not contain '.'
+             */
+            id: string;
+            /**
+             * Custom metadata for the entitlement
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach resources to a product to grant features to
+ * customers.
+ */
+export interface ProductUpdateResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    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?: ProductUpdateResponse.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductUpdateResponse.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string | null;
+    /**
+     * Resources attached to this product. Customers get access to these resources when
+     * they purchase the product.
+     */
+    resources?: Array<ProductUpdateResponse.Resource>;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductUpdateResponse {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        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;
+    }
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+    /**
+     * A resource that can be attached to products to grant access to customers.
+     * Resources represent monetizable content or features in your app.
+     */
+    interface Resource {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        id: string;
+        /**
+         * Whether the resource is active and grants access
+         */
+        active: boolean;
+        /**
+         * Timestamp when the resource was created
+         */
+        created: string;
+        /**
+         * Type of resource: custom_entitlement, file, content, course, or ticket
+         */
+        type: 'custom_entitlement' | 'file' | 'content' | 'course' | 'ticket';
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        custom_entitlement?: Resource.CustomEntitlement | null;
+    }
+    namespace Resource {
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        interface CustomEntitlement {
+            /**
+             * Unique identifier for the custom entitlement. Must not contain '.'
+             */
+            id: string;
+            /**
+             * Custom metadata for the entitlement
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach resources to a product to grant features to
+ * customers.
+ */
+export interface ProductListResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    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?: ProductListResponse.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductListResponse.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string | null;
+    /**
+     * Resources attached to this product. Customers get access to these resources when
+     * they purchase the product.
+     */
+    resources?: Array<ProductListResponse.Resource>;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductListResponse {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        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;
+    }
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+    /**
+     * A resource that can be attached to products to grant access to customers.
+     * Resources represent monetizable content or features in your app.
+     */
+    interface Resource {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        id: string;
+        /**
+         * Whether the resource is active and grants access
+         */
+        active: boolean;
+        /**
+         * Timestamp when the resource was created
+         */
+        created: string;
+        /**
+         * Type of resource: custom_entitlement, file, content, course, or ticket
+         */
+        type: 'custom_entitlement' | 'file' | 'content' | 'course' | 'ticket';
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        custom_entitlement?: Resource.CustomEntitlement | null;
+    }
+    namespace Resource {
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        interface CustomEntitlement {
+            /**
+             * Unique identifier for the custom entitlement. Must not contain '.'
+             */
+            id: string;
+            /**
+             * Custom metadata for the entitlement
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach resources to a product to grant features to
+ * customers.
+ */
+export interface ProductArchiveResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    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?: ProductArchiveResponse.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductArchiveResponse.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string | null;
+    /**
+     * Resources attached to this product. Customers get access to these resources when
+     * they purchase the product.
+     */
+    resources?: Array<ProductArchiveResponse.Resource>;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductArchiveResponse {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        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;
+    }
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+    /**
+     * A resource that can be attached to products to grant access to customers.
+     * Resources represent monetizable content or features in your app.
+     */
+    interface Resource {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        id: string;
+        /**
+         * Whether the resource is active and grants access
+         */
+        active: boolean;
+        /**
+         * Timestamp when the resource was created
+         */
+        created: string;
+        /**
+         * Type of resource: custom_entitlement, file, content, course, or ticket
+         */
+        type: 'custom_entitlement' | 'file' | 'content' | 'course' | 'ticket';
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        custom_entitlement?: Resource.CustomEntitlement | null;
+    }
+    namespace Resource {
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        interface CustomEntitlement {
+            /**
+             * Unique identifier for the custom entitlement. Must not contain '.'
+             */
+            id: string;
+            /**
+             * Custom metadata for the entitlement
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+/**
+ * A product that customers can purchase. Products can be one-time purchases or
+ * recurring subscriptions. Attach resources to a product to grant features to
+ * customers.
+ */
+export interface ProductGetResponse {
+    /**
+     * Unique identifier for the topic subscription
+     */
+    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?: ProductGetResponse.DefaultPrice | null;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string | null;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductGetResponse.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string | null;
+    /**
+     * Resources attached to this product. Customers get access to these resources when
+     * they purchase the product.
+     */
+    resources?: Array<ProductGetResponse.Resource>;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductGetResponse {
+    /**
+     * Price configuration for a product. Can be one-time or recurring (subscription).
+     */
+    interface DefaultPrice {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        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;
+    }
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+    /**
+     * A resource that can be attached to products to grant access to customers.
+     * Resources represent monetizable content or features in your app.
+     */
+    interface Resource {
+        /**
+         * Unique identifier for the topic subscription
+         */
+        id: string;
+        /**
+         * Whether the resource is active and grants access
+         */
+        active: boolean;
+        /**
+         * Timestamp when the resource was created
+         */
+        created: string;
+        /**
+         * Type of resource: custom_entitlement, file, content, course, or ticket
+         */
+        type: 'custom_entitlement' | 'file' | 'content' | 'course' | 'ticket';
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        custom_entitlement?: Resource.CustomEntitlement | null;
+    }
+    namespace Resource {
+        /**
+         * Custom entitlement data. Required when type is 'custom_entitlement'.
+         */
+        interface CustomEntitlement {
+            /**
+             * Unique identifier for the custom entitlement. Must not contain '.'
+             */
+            id: string;
+            /**
+             * Custom metadata for the entitlement
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
+        }
+    }
+}
+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;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductCreateParams.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * ID of the product group this product belongs to. Product groups define shared
+     * billing configuration.
+     */
+    product_group_id?: string;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+    /**
+     * Price type: one_time for single purchases, recurring for subscriptions
+     */
+    type?: 'one_time' | 'recurring';
+}
+export declare namespace ProductCreateParams {
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+}
+export interface ProductUpdateParams {
+    /**
+     * Whether the product is available for new subscriptions
+     */
+    active?: boolean;
+    /**
+     * Detailed description of what the product includes
+     */
+    description?: string;
+    /**
+     * Media attachments (images, videos) for the product
+     */
+    media?: Array<ProductUpdateParams.Media>;
+    /**
+     * Custom metadata for the product
+     */
+    metadata?: {
+        [key: string]: unknown;
+    };
+    /**
+     * Display name for the product
+     */
+    name?: string;
+    /**
+     * ID of the product group. Set to null to remove from a group.
+     */
+    product_group_id?: string | null;
+    /**
+     * Tags for categorizing and filtering products
+     */
+    tags?: Array<string>;
+}
+export declare namespace ProductUpdateParams {
+    /**
+     * Media attachment for products or variants
+     */
+    interface Media {
+        /**
+         * Type of media: image, video, or external link
+         */
+        type: 'image' | 'video' | 'external';
+        /**
+         * URL of the media resource
+         */
+        url: string;
+    }
+}
+export interface ProductListParams extends CursorIDPageParams {
+    /**
+     * Filter by active status
+     */
+    active?: 'true' | 'false';
+}
+export declare namespace Products {
+    export { type ProductCreateResponse as ProductCreateResponse, type ProductUpdateResponse as ProductUpdateResponse, type ProductListResponse as ProductListResponse, type ProductArchiveResponse as ProductArchiveResponse, type ProductGetResponse as ProductGetResponse, type ProductListResponsesCursorIDPage as ProductListResponsesCursorIDPage, type ProductCreateParams as ProductCreateParams, type ProductUpdateParams as ProductUpdateParams, type ProductListParams as ProductListParams, };
+    export { Resources as Resources, type ResourceListResponse as ResourceListResponse, type ResourceAttachResponse as ResourceAttachResponse, type ResourceListResponsesCursorIDPage as ResourceListResponsesCursorIDPage, type ResourceListParams as ResourceListParams, type ResourceAttachParams as ResourceAttachParams, type ResourceRemoveParams as ResourceRemoveParams, };
+    export { Variants as Variants, type VariantCreateResponse as VariantCreateResponse, type VariantUpdateResponse as VariantUpdateResponse, type VariantListResponse as VariantListResponse, type VariantArchiveResponse as VariantArchiveResponse, type VariantGetResponse as VariantGetResponse, type VariantListResponsesCursorIDPage as VariantListResponsesCursorIDPage, type VariantCreateParams as VariantCreateParams, type VariantUpdateParams as VariantUpdateParams, type VariantListParams as VariantListParams, type VariantArchiveParams as VariantArchiveParams, type VariantGetParams as VariantGetParams, };
+}
+//# sourceMappingURL=products.d.mts.map