@stigg/typescript 0.1.0-beta.2 → 0.1.0-beta.21

package/resources/v1/subscriptions/subscriptions.d.ts

@@ -1,10 +1,10 @@
 import { APIResource } from "../../../core/resource.js";
 import * as FutureUpdateAPI from "./future-update.js";
-import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate } from "./future-update.js";
+import { CancelSubscription, FutureUpdate as FutureUpdateAPIFutureUpdate, FutureUpdateCancelPendingPaymentParams, FutureUpdateCancelScheduleParams } from "./future-update.js";
 import * as InvoiceAPI from "./invoice.js";
-import { Invoice, InvoiceMarkAsPaidResponse } from "./invoice.js";
+import { Invoice, InvoiceMarkAsPaidParams, InvoiceMarkAsPaidResponse } from "./invoice.js";
 import * as UsageAPI from "./usage.js";
-import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncResponse } from "./usage.js";
+import { Usage, UsageChargeUsageParams, UsageChargeUsageResponse, UsageSyncParams, UsageSyncResponse } from "./usage.js";
 import { APIPromise } from "../../../core/api-promise.js";
 import { MyCursorIDPage, type MyCursorIDPageParams, PagePromise } from "../../../core/pagination.js";
 import { RequestOptions } from "../../../internal/request-options.js";
@@ -15,53 +15,134 @@ export declare class Subscriptions extends APIResource {
     /**
      * Retrieves a subscription by its unique identifier, including plan details,
      * billing period, status, and add-ons.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.retrieve(
+     *   'x',
+     * );
+     * ```
      */
-    retrieve(id: string, options?: RequestOptions): APIPromise<Subscription>;
+    retrieve(id: string, params?: SubscriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Updates an active subscription's properties including billing period, add-ons,
      * unit quantities, and discounts.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.update(
+     *   'x',
+     * );
+     * ```
      */
-    update(id: string, body: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
+    update(id: string, params: SubscriptionUpdateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Retrieves a paginated list of subscriptions, with optional filters for customer,
      * status, and plan.
+     *
+     * @example
+     * ```ts
+     * // Automatically fetches more pages as needed.
+     * for await (const subscriptionListResponse of client.v1.subscriptions.list()) {
+     *   // ...
+     * }
+     * ```
      */
-    list(query?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
+    list(params?: SubscriptionListParams | null | undefined, options?: RequestOptions): PagePromise<SubscriptionListResponsesMyCursorIDPage, SubscriptionListResponse>;
     /**
      * Cancels an active subscription, either immediately or at a specified time such
      * as end of billing period.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.cancel(
+     *   'x',
+     * );
+     * ```
      */
-    cancel(id: string, body: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
+    cancel(id: string, params: SubscriptionCancelParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Delegates the payment responsibility of a subscription to a different customer.
      * The delegated customer will be billed for this subscription.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.delegate(
+     *   'x',
+     *   { targetCustomerId: 'targetCustomerId' },
+     * );
+     * ```
      */
-    delegate(id: string, body: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
+    delegate(id: string, params: SubscriptionDelegateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Imports multiple subscriptions in bulk. Used for migrating subscription data
      * from external systems.
-     */
-    import(body: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.import({
+     *   subscriptions: [
+     *     {
+     *       id: 'id',
+     *       customerId: 'customerId',
+     *       planId: 'planId',
+     *     },
+     *   ],
+     * });
+     * ```
+     */
+    import(params: SubscriptionImportParams, options?: RequestOptions): APIPromise<SubscriptionImportResponse>;
     /**
      * Migrates a subscription to the latest published version of its plan or add-ons.
      * Handles prorated charges or credits automatically.
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.migrate(
+     *   'x',
+     * );
+     * ```
      */
-    migrate(id: string, body: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
+    migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): APIPromise<Subscription>;
     /**
      * Previews the pricing impact of creating or updating a subscription without
      * making changes. Returns estimated costs, taxes, and proration details.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.preview({
+     *   customerId: 'customerId',
+     *   planId: 'planId',
+     * });
+     * ```
      */
-    preview(body: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
+    preview(params: SubscriptionPreviewParams, options?: RequestOptions): APIPromise<SubscriptionPreviewResponse>;
     /**
      * Creates a new subscription for an existing customer. When payment is required
      * and no payment method exists, returns a checkout URL.
+     *
+     * @example
+     * ```ts
+     * const response = await client.v1.subscriptions.provision({
+     *   customerId: 'customerId',
+     *   planId: 'planId',
+     * });
+     * ```
      */
-    provision(body: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
+    provision(params: SubscriptionProvisionParams, options?: RequestOptions): APIPromise<SubscriptionProvisionResponse>;
     /**
      * Transfers a subscription to a different resource ID. Used for multi-resource
      * products where subscriptions apply to specific entities like websites or apps.
-     */
-    transfer(id: string, body: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
+     *
+     * @example
+     * ```ts
+     * const subscription = await client.v1.subscriptions.transfer(
+     *   'x',
+     *   { destinationResourceId: 'destinationResourceId' },
+     * );
+     * ```
+     */
+    transfer(id: string, params: SubscriptionTransferParams, options?: RequestOptions): APIPromise<Subscription>;
 }
 export type SubscriptionListResponsesMyCursorIDPage = MyCursorIDPage<SubscriptionListResponse>;
 /**
@@ -1659,39 +1740,97 @@ export declare namespace SubscriptionProvisionResponse {
         }
     }
 }
+export interface SubscriptionRetrieveParams {
+    /**
+     * Account ID — optional when authenticating with a user JWT (Bearer token); falls
+     * back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Environment ID — required when authenticating with a user JWT (Bearer token) on
+     * environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the
+     * key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
+}
 export interface SubscriptionUpdateParams {
+    /**
+     * Body param
+     */
     addons?: Array<SubscriptionUpdateParams.Addon>;
+    /**
+     * Body param
+     */
     appliedCoupon?: SubscriptionUpdateParams.AppliedCoupon;
     /**
-     * Await payment confirmation
+     * Body param: Await payment confirmation
      */
     awaitPaymentConfirmation?: boolean;
+    /**
+     * Body param
+     */
     billingCycleAnchor?: 'UNCHANGED' | 'NOW';
+    /**
+     * Body param
+     */
     billingInformation?: SubscriptionUpdateParams.BillingInformation;
+    /**
+     * Body param
+     */
     billingPeriod?: 'MONTHLY' | 'ANNUALLY';
+    /**
+     * Body param
+     */
     budget?: SubscriptionUpdateParams.Budget | null;
+    /**
+     * Body param: Subscription cancellation date
+     */
+    cancellationDate?: string | null;
+    /**
+     * Body param
+     */
     charges?: Array<SubscriptionUpdateParams.Charge>;
+    /**
+     * Body param
+     */
     entitlements?: Array<SubscriptionUpdateParams.Feature | SubscriptionUpdateParams.Credit>;
     /**
-     * Additional metadata for the subscription
+     * Body param: Additional metadata for the subscription
      */
     metadata?: {
         [key: string]: string;
     };
     /**
-     * Minimum spend amount
+     * Body param: Minimum spend amount
      */
     minimumSpend?: SubscriptionUpdateParams.MinimumSpend | null;
+    /**
+     * Body param
+     */
     priceOverrides?: Array<SubscriptionUpdateParams.PriceOverride>;
     /**
-     * Promotion code
+     * Body param: Promotion code
      */
     promotionCode?: string;
+    /**
+     * Body param
+     */
     scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
     /**
-     * Subscription trial end date
+     * Body param: Subscription trial end date
      */
     trialEndDate?: string;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace SubscriptionUpdateParams {
     /**
@@ -1955,30 +2094,42 @@ export declare namespace SubscriptionUpdateParams {
 }
 export interface SubscriptionListParams extends MyCursorIDPageParams {
     /**
-     * Filter by creation date using range operators: gt, gte, lt, lte
+     * Query param: Filter by creation date using range operators: gt, gte, lt, lte
      */
     createdAt?: SubscriptionListParams.CreatedAt;
     /**
-     * Filter by customer ID
+     * Query param: Filter by customer ID
      */
     customerId?: string;
     /**
-     * Filter by plan ID
+     * Query param: Filter by plan ID
      */
     planId?: string;
     /**
-     * Filter by pricing type. Supports comma-separated values for multiple types
+     * Query param: Filter by pricing type. Supports comma-separated values for
+     * multiple types
      */
     pricingType?: Array<'FREE' | 'PAID' | 'CUSTOM'>;
     /**
-     * Filter by resource ID
+     * Query param: Filter by resource ID
      */
     resourceId?: string;
     /**
-     * Filter by subscription status. Supports comma-separated values for multiple
-     * statuses
+     * Query param: Filter by subscription status. Supports comma-separated values for
+     * multiple statuses
      */
     status?: Array<'PAYMENT_PENDING' | 'ACTIVE' | 'EXPIRED' | 'IN_TRIAL' | 'CANCELED' | 'NOT_STARTED'>;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace SubscriptionListParams {
     /**
@@ -2005,39 +2156,74 @@ export declare namespace SubscriptionListParams {
 }
 export interface SubscriptionCancelParams {
     /**
-     * Action on cancellation (downgrade or revoke)
+     * Body param: Action on cancellation (downgrade or revoke)
      */
     cancellationAction?: 'DEFAULT' | 'REVOKE_ENTITLEMENTS';
     /**
-     * When to cancel (immediate, period end, or date)
+     * Body param: When to cancel (immediate, period end, or date)
      */
     cancellationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE' | 'SPECIFIC_DATE';
     /**
-     * Subscription end date
+     * Body param: Subscription end date
      */
     endDate?: string;
     /**
-     * If set, enables or disables prorating of credits on subscription cancellation.
+     * Body param: If set, enables or disables prorating of credits on subscription
+     * cancellation.
      */
     prorate?: boolean;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export interface SubscriptionDelegateParams {
     /**
-     * The unique identifier of the customer who will assume payment responsibility for
-     * this subscription. This customer must already exist in your Stigg account and
-     * have a valid payment method if the subscription requires payment.
+     * Body param: The unique identifier of the customer who will assume payment
+     * responsibility for this subscription. This customer must already exist in your
+     * Stigg account and have a valid payment method if the subscription requires
+     * payment.
      */
     targetCustomerId: string;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export interface SubscriptionImportParams {
     /**
-     * List of subscription objects to import
+     * Body param: List of subscription objects to import
      */
     subscriptions: Array<SubscriptionImportParams.Subscription>;
     /**
-     * Integration ID to use for importing subscriptions
+     * Body param: Integration ID to use for importing subscriptions
      */
     integrationId?: string | null;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace SubscriptionImportParams {
     interface Subscription {
@@ -2097,7 +2283,8 @@ export declare namespace SubscriptionImportParams {
             quantity: number;
         }
         /**
-         * Charge item
+         * A charge selection for a subscription (references a catalog charge with a
+         * quantity).
          */
         interface Charge {
             /**
@@ -2105,7 +2292,7 @@ export declare namespace SubscriptionImportParams {
              */
             id: string;
             /**
-             * Charge quantity
+             * Charge quantity. Minimum is 0 (zero is allowed).
              */
             quantity: number;
             /**
@@ -2117,75 +2304,97 @@ export declare namespace SubscriptionImportParams {
 }
 export interface SubscriptionMigrateParams {
     /**
-     * When to migrate (immediate or period end)
+     * Body param: When to migrate (immediate or period end)
      */
     subscriptionMigrationTime?: 'END_OF_BILLING_PERIOD' | 'IMMEDIATE';
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export interface SubscriptionPreviewParams {
     /**
-     * Customer ID
+     * Body param: Customer ID
      */
     customerId: string;
     /**
-     * Plan ID
+     * Body param: Plan ID
      */
     planId: string;
     /**
-     * Addons to include
+     * Body param: Addons to include
      */
     addons?: Array<SubscriptionPreviewParams.Addon>;
     /**
-     * Coupon or discount to apply
+     * Body param: Coupon or discount to apply
      */
     appliedCoupon?: SubscriptionPreviewParams.AppliedCoupon;
     /**
-     * Billable features with quantities
+     * Body param: Billable features with quantities
      */
     billableFeatures?: Array<SubscriptionPreviewParams.BillableFeature>;
     /**
-     * ISO 3166-1 country code for localization
+     * Body param: ISO 3166-1 country code for localization
      */
     billingCountryCode?: string;
     /**
-     * Billing cycle anchor behavior for the subscription
+     * Body param: Billing cycle anchor behavior for the subscription
      */
     billingCycleAnchor?: 'UNCHANGED' | 'NOW';
     /**
-     * Billing and tax configuration
+     * Body param: Billing and tax configuration
      */
     billingInformation?: SubscriptionPreviewParams.BillingInformation;
     /**
-     * Billing period (MONTHLY or ANNUALLY)
+     * Body param: Billing period (MONTHLY or ANNUALLY)
      */
     billingPeriod?: 'MONTHLY' | 'ANNUALLY';
     /**
-     * One-time or recurring charges
+     * Body param: One-time or recurring charges
      */
     charges?: Array<SubscriptionPreviewParams.Charge>;
     /**
-     * Paying customer ID for delegated billing
+     * Body param: Paying customer ID for delegated billing
      */
     payingCustomerId?: string;
     /**
-     * Resource ID for multi-instance subscriptions
+     * Body param: Resource ID for multi-instance subscriptions
      */
     resourceId?: string;
     /**
-     * When to apply subscription changes
+     * Body param: When to apply subscription changes
      */
     scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
     /**
-     * Subscription start date
+     * Body param: Subscription start date
      */
     startDate?: string;
     /**
-     * Trial period override settings
+     * Body param: Trial period override settings
      */
     trialOverrideConfiguration?: SubscriptionPreviewParams.TrialOverrideConfiguration;
     /**
-     * Unit quantity for per-unit pricing
+     * Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
      */
     unitQuantity?: number;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace SubscriptionPreviewParams {
     /**
@@ -2283,7 +2492,7 @@ export declare namespace SubscriptionPreviewParams {
          */
         featureId: string;
         /**
-         * Quantity of feature units
+         * Quantity of feature units. Minimum is 0 (zero is allowed).
          */
         quantity: number;
     }
@@ -2365,7 +2574,8 @@ export declare namespace SubscriptionPreviewParams {
         }
     }
     /**
-     * Charge item
+     * A charge selection for a subscription (references a catalog charge with a
+     * quantity).
      */
     interface Charge {
         /**
@@ -2373,7 +2583,7 @@ export declare namespace SubscriptionPreviewParams {
          */
         id: string;
         /**
-         * Charge quantity
+         * Charge quantity. Minimum is 0 (zero is allowed).
          */
         quantity: number;
         /**
@@ -2401,93 +2611,127 @@ export declare namespace SubscriptionPreviewParams {
 }
 export interface SubscriptionProvisionParams {
     /**
-     * Customer ID to provision the subscription for
+     * Body param: Customer ID to provision the subscription for
      */
     customerId: string;
     /**
-     * Plan ID to provision
+     * Body param: Plan ID to provision
      */
     planId: string;
     /**
-     * Unique identifier for the subscription
+     * Body param: Unique identifier for the subscription
      */
     id?: string;
+    /**
+     * Body param
+     */
     addons?: Array<SubscriptionProvisionParams.Addon>;
     /**
-     * Coupon configuration
+     * Body param: Coupon configuration
      */
     appliedCoupon?: SubscriptionProvisionParams.AppliedCoupon;
     /**
-     * Whether to wait for payment confirmation before returning the subscription
+     * Body param: Whether to wait for payment confirmation before returning the
+     * subscription
      */
     awaitPaymentConfirmation?: boolean;
     /**
-     * The ISO 3166-1 alpha-2 country code for billing
+     * Body param: The ISO 3166-1 alpha-2 country code for billing
      */
     billingCountryCode?: string | null;
     /**
-     * Billing cycle anchor behavior for the subscription
+     * Body param: Billing cycle anchor behavior for the subscription
      */
     billingCycleAnchor?: 'UNCHANGED' | 'NOW';
     /**
-     * External billing system identifier
+     * Body param: External billing system identifier
      */
     billingId?: string | null;
+    /**
+     * Body param
+     */
     billingInformation?: SubscriptionProvisionParams.BillingInformation;
     /**
-     * Billing period (MONTHLY or ANNUALLY)
+     * Body param: Billing period (MONTHLY or ANNUALLY)
      */
     billingPeriod?: 'MONTHLY' | 'ANNUALLY';
+    /**
+     * Body param
+     */
     budget?: SubscriptionProvisionParams.Budget | null;
+    /**
+     * Body param: Subscription cancellation date
+     */
+    cancellationDate?: string;
+    /**
+     * Body param
+     */
     charges?: Array<SubscriptionProvisionParams.Charge>;
     /**
-     * Checkout page configuration for payment collection
+     * Body param: Checkout page configuration for payment collection
      */
     checkoutOptions?: SubscriptionProvisionParams.CheckoutOptions;
+    /**
+     * Body param
+     */
     entitlements?: Array<SubscriptionProvisionParams.Feature | SubscriptionProvisionParams.Credit>;
     /**
-     * Additional metadata for the subscription
+     * Body param: Additional metadata for the subscription
      */
     metadata?: {
         [key: string]: string;
     };
     /**
-     * Minimum spend amount
+     * Body param: Minimum spend amount
      */
     minimumSpend?: SubscriptionProvisionParams.MinimumSpend | null;
     /**
-     * Optional paying customer ID for split billing scenarios
+     * Body param: Optional paying customer ID for split billing scenarios
      */
     payingCustomerId?: string | null;
     /**
-     * How payments should be collected for this subscription
+     * Body param: How payments should be collected for this subscription
      */
     paymentCollectionMethod?: 'CHARGE' | 'INVOICE' | 'NONE';
+    /**
+     * Body param
+     */
     priceOverrides?: Array<SubscriptionProvisionParams.PriceOverride>;
     /**
-     * Optional resource ID for multi-instance subscriptions
+     * Body param: Optional resource ID for multi-instance subscriptions
      */
     resourceId?: string | null;
     /**
-     * Salesforce ID
+     * Body param: Salesforce ID
      */
     salesforceId?: string | null;
     /**
-     * Strategy for scheduling subscription changes
+     * Body param: Strategy for scheduling subscription changes
      */
     scheduleStrategy?: 'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE';
     /**
-     * Subscription start date
+     * Body param: Subscription start date
      */
     startDate?: string;
     /**
-     * Trial period override settings
+     * Body param: Trial period override settings
      */
     trialOverrideConfiguration?: SubscriptionProvisionParams.TrialOverrideConfiguration;
     /**
-     * Unit quantity
+     * Body param: Unit quantity for per-unit pricing. Minimum is 0 (zero is allowed).
      */
     unitQuantity?: number;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace SubscriptionProvisionParams {
     /**
@@ -2661,7 +2905,8 @@ export declare namespace SubscriptionProvisionParams {
         limit: number;
     }
     /**
-     * Charge item
+     * A charge selection for a subscription (references a catalog charge with a
+     * quantity).
      */
     interface Charge {
         /**
@@ -2669,7 +2914,7 @@ export declare namespace SubscriptionProvisionParams {
          */
         id: string;
         /**
-         * Charge quantity
+         * Charge quantity. Minimum is 0 (zero is allowed).
          */
         quantity: number;
         /**
@@ -2928,14 +3173,25 @@ export declare namespace SubscriptionProvisionParams {
 }
 export interface SubscriptionTransferParams {
     /**
-     * Resource ID to transfer the subscription to
+     * Body param: Resource ID to transfer the subscription to
      */
     destinationResourceId: string;
+    /**
+     * Header param: Account ID — optional when authenticating with a user JWT (Bearer
+     * token); falls back to the user's first membership. Ignored for API-key auth.
+     */
+    'X-ACCOUNT-ID'?: string;
+    /**
+     * Header param: Environment ID — required when authenticating with a user JWT
+     * (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is
+     * intrinsic to the key).
+     */
+    'X-ENVIRONMENT-ID'?: string;
 }
 export declare namespace Subscriptions {
-    export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
-    export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription };
-    export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, };
-    export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse };
+    export { type Subscription as Subscription, type SubscriptionListResponse as SubscriptionListResponse, type SubscriptionImportResponse as SubscriptionImportResponse, type SubscriptionPreviewResponse as SubscriptionPreviewResponse, type SubscriptionProvisionResponse as SubscriptionProvisionResponse, type SubscriptionListResponsesMyCursorIDPage as SubscriptionListResponsesMyCursorIDPage, type SubscriptionRetrieveParams as SubscriptionRetrieveParams, type SubscriptionUpdateParams as SubscriptionUpdateParams, type SubscriptionListParams as SubscriptionListParams, type SubscriptionCancelParams as SubscriptionCancelParams, type SubscriptionDelegateParams as SubscriptionDelegateParams, type SubscriptionImportParams as SubscriptionImportParams, type SubscriptionMigrateParams as SubscriptionMigrateParams, type SubscriptionPreviewParams as SubscriptionPreviewParams, type SubscriptionProvisionParams as SubscriptionProvisionParams, type SubscriptionTransferParams as SubscriptionTransferParams, };
+    export { FutureUpdateAPIFutureUpdate as FutureUpdate, type CancelSubscription as CancelSubscription, type FutureUpdateCancelPendingPaymentParams as FutureUpdateCancelPendingPaymentParams, type FutureUpdateCancelScheduleParams as FutureUpdateCancelScheduleParams, };
+    export { Usage as Usage, type UsageChargeUsageResponse as UsageChargeUsageResponse, type UsageSyncResponse as UsageSyncResponse, type UsageChargeUsageParams as UsageChargeUsageParams, type UsageSyncParams as UsageSyncParams, };
+    export { Invoice as Invoice, type InvoiceMarkAsPaidResponse as InvoiceMarkAsPaidResponse, type InvoiceMarkAsPaidParams as InvoiceMarkAsPaidParams, };
 }
 //# sourceMappingURL=subscriptions.d.ts.map