@stripe/extensibility-sdk 0.26.0 → 0.27.1

package/dist/extensibility-sdk-internal.d.ts

@@ -163,7 +163,7 @@ declare namespace Bill {
 declare namespace Billing {
     export {
         CustomerBalanceApplication,
-        InvoiceCollectionSetting,
+        InvoiceCollectionOptions,
         Prorations,
         RecurringBillingItemHandling,
         Bill,
@@ -612,7 +612,7 @@ declare interface CustomerBalanceApplication<Config> {
  *
  * @example
  * ```ts
- * import { Decimal, RoundDirection } from '@stripe/extensibility-sdk/stdlib';
+ * import { Decimal, RoundDirection } from '@stripe/extensibility-sdk';
  *
  * const price = Decimal.from('19.99');
  * const tax   = price.mul(Decimal.from('0.0825'));
@@ -1203,58 +1203,65 @@ export declare interface IntegerCompanion {
 export declare type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
 
 /** @public */
-declare namespace InvoiceCollectionSetting {
+declare namespace InvoiceCollectionOptions {
     /** @public */
-    type ParentType = 'billing_cadence' | 'contract' | 'quote' | 'standalone' | 'subscription_schedule' | 'subscription';
-    /** @public */
-    type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'klarna' | 'konbini' | 'link' | 'multibanco' | 'oxxo' | 'p24' | 'paynow' | 'paypal' | 'promptpay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'us_bank_account' | 'wechat_pay';
+    type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'klarna' | 'konbini' | 'link' | 'multibanco' | 'oxxo' | 'p24' | 'paynow' | 'paypal' | 'promptpay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'us_bank_account' | 'wechat_pay';
     /** @public */
     type CollectionMethod = 'charge_automatically' | 'send_invoice';
     /**
-     * The result of the invoice collection settings override extension.
+     * The result of the invoice collection options override extension.
      * @public
      */
-    interface InvoiceCollectionResponse {
+    interface InvoiceCollectionOptionsResult {
         /** Override the auto-advancement setting. Set to false to keep the invoice in draft. Return null to use the default. */
         autoAdvance?: boolean;
     }
     /** @public */
-    type InvoiceCollectionRequest = ({
+    type InvoiceCollectionOptionsInput = ({
         customer: Customer;
         payer: 'customer';
     } | {
         otherPayer: string;
         payer: 'other';
-    }) & {
-        collectionSettings: CollectionSettings;
-        parent: Parent;
-    };
+    }) & ({
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | { invoiceParentType: 'cadence' } | { invoiceParentType: 'contract' } | { invoiceParentType: 'quote' } | { invoiceParentType: 'schedule' }) & { collectionOptions: CollectionOptions };
     /** @public */
     interface Customer {
         id: string;
         metadata: Record<string, string>;
     }
+    /** @public */
+    type ContractParent = Record<string, never>;
     /**
-     * The parent resource that triggered the invoice creation.
+     * The Subscription that triggered the invoice creation.
      * @public
      */
-    interface Parent {
-        /** The type of parent resource (for example, subscription or contract). */
-        type: ParentType;
-        /** Custom key-value pairs attached to the parent resource. */
+    interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
         metadata: Record<string, string>;
     }
+    /** @public */
+    type ScheduleParent = Record<string, never>;
+    /** @public */
+    type QuoteParent = Record<string, never>;
+    /** @public */
+    type CadenceParent = Record<string, never>;
     /**
-     * The collection settings for an invoice.
+     * The collection options for an invoice.
      * @public
      */
-    interface CollectionSettings {
+    interface CollectionOptions {
         /** Whether the invoice automatically advances through its lifecycle. */
         autoAdvance: boolean;
         /** The payment collection method: charge_automatically or send_invoice. */
         collectionMethod: CollectionMethod;
-        /** The delay before the invoice is finalized, in hours. */
-        finalizationGracePeriod: number;
         /** The payment methods configured for this invoice. */
         paymentMethods: PaymentMethodType[];
     }
@@ -1262,56 +1269,34 @@ declare namespace InvoiceCollectionSetting {
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    function prepareArgsCollectionOverride(proto: unknown): InvoiceCollectionRequest;
+    function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    function prepareResultCollectionOverride(result: InvoiceCollectionResponse): InvoiceCollectionResponse;
+    function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
     /** @internal */
-    function $platformWrapCollectionOverride(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { collectionOverride(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    function $platformWrapOverrideOptions(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => { overrideOptions(...a: unknown[]): unknown }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    const prepareArgs: typeof prepareArgsCollectionOverride;
+    const prepareArgs: typeof prepareArgsOverrideOptions;
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    const prepareResult: typeof prepareResultCollectionOverride;
+    const prepareResult: typeof prepareResultOverrideOptions;
     /**
-     * Overrides invoice collection settings before a draft invoice is created.
+     * Overrides invoice collection options before a draft invoice is created.
      * @public
      */
-    type CollectionOverrideFunction<Config> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
+    type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
 }
 
-/**
- * @example
- * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk';
- *
- * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyInvoiceCollectionSettingConfig {}
- *
- * export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
- *   collectionOverride(
- *     _request: Billing.InvoiceCollectionSetting.InvoiceCollectionRequest,
- *     _config: MyInvoiceCollectionSettingConfig,
- *     _context: Context
- *   ) {
- *     // TODO: implement your collection setting logic here
- *
- *     return {};
- *   }
- * }
- *
- * ```
- * @public
- */
-declare interface InvoiceCollectionSetting<Config> {
-    collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
+/** @public */
+declare interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
 }
 
 /**
@@ -1742,6 +1727,15 @@ declare namespace RecurringBillingItemHandling {
     }
     /** @public */
     type Item = ({
+        creditedItems: 'invoiceItem';
+        invoiceItem: CreditedInvoiceItem;
+    } | {
+        creditedItems: 'invoiceLineItems';
+        invoiceLineItems: InvoiceLineItems;
+    } | {
+        creditedItems: 'other';
+        otherCreditedItems: string;
+    }) & ({
         customPricingUnitOverageRate: CustomPricingUnitOverageRate;
         priceKind: 'customPricingUnitOverageRate';
     } | {
@@ -1763,6 +1757,40 @@ declare namespace RecurringBillingItemHandling {
         servicePeriod: AnyTimeRange;
         type: ItemType;
     };
+    /**
+     * The invoice item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceItem {
+        /** The id of the invoice item. */
+        id: string;
+    }
+    /**
+     * Information about debit line items corresponding to a credit item.
+     * @public
+     */
+    interface InvoiceLineItems {
+        /** The invoice containing the line items. */
+        invoice: CreditedInvoice;
+        /** The line items corresponding to the credit. */
+        invoiceLineItems: CreditedInvoiceLineItem[];
+    }
+    /**
+     * The invoice line item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceLineItem {
+        /** The id of the invoice line item. */
+        id: string;
+    }
+    /**
+     * The invoice corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoice {
+        /** The id of the invoice. */
+        id: string;
+    }
     /** @public */
     interface CustomPricingUnitOverageRate {
         id: string;
@@ -2026,9 +2054,6 @@ export declare type Ref<T extends {
     readonly [__stripeType]: 'string';
 };
 
-/** Factory for creating {@link (Ref:type)} values from an object with `object` and `id` fields. @public */
-export declare const Ref: { create: <T extends { readonly object: string }>(step: { readonly id: string } & T) => Ref<T> };
-
 /**
  * Wraps a transformer so that a `null` / `undefined` result throws
  * `WireParseError('Required field is missing')`, which `strategy.applyField`
@@ -2102,7 +2127,7 @@ declare interface TimeRange {
  *
  * @example
  * ```typescript
- * import { toConst } from '@stripe/extensibility-sdk/stdlib';
+ * import { toConst } from '@stripe/extensibility-sdk';
  *
  * const DEFAULTS = toConst({ timeout: 30, retries: 3 });
  * // Type: { readonly timeout: 30; readonly retries: 3 }

package/dist/extensibility-sdk-public.d.ts

@@ -91,7 +91,7 @@ declare namespace Bill {
 declare namespace Billing {
     export {
         CustomerBalanceApplication,
-        InvoiceCollectionSetting,
+        InvoiceCollectionOptions,
         Prorations,
         RecurringBillingItemHandling,
         Bill,
@@ -495,7 +495,7 @@ declare interface CustomerBalanceApplication<Config> {
  *
  * @example
  * ```ts
- * import { Decimal, RoundDirection } from '@stripe/extensibility-sdk/stdlib';
+ * import { Decimal, RoundDirection } from '@stripe/extensibility-sdk';
  *
  * const price = Decimal.from('19.99');
  * const tax   = price.mul(Decimal.from('0.0825'));
@@ -1034,58 +1034,65 @@ export declare interface IntegerCompanion {
 export declare type IntegerRoundDirection = 'ceil' | 'floor' | 'half-up' | 'round-down' | 'round-up';
 
 /** @public */
-declare namespace InvoiceCollectionSetting {
+declare namespace InvoiceCollectionOptions {
     /** @public */
-    type ParentType = 'billing_cadence' | 'contract' | 'quote' | 'standalone' | 'subscription_schedule' | 'subscription';
-    /** @public */
-    type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'klarna' | 'konbini' | 'link' | 'multibanco' | 'oxxo' | 'p24' | 'paynow' | 'paypal' | 'promptpay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'us_bank_account' | 'wechat_pay';
+    type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'affirm' | 'afterpay_clearpay' | 'alipay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'klarna' | 'konbini' | 'link' | 'multibanco' | 'oxxo' | 'p24' | 'paynow' | 'paypal' | 'promptpay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'us_bank_account' | 'wechat_pay';
     /** @public */
     type CollectionMethod = 'charge_automatically' | 'send_invoice';
     /**
-     * The result of the invoice collection settings override extension.
+     * The result of the invoice collection options override extension.
      * @public
      */
-    interface InvoiceCollectionResponse {
+    interface InvoiceCollectionOptionsResult {
         /** Override the auto-advancement setting. Set to false to keep the invoice in draft. Return null to use the default. */
         autoAdvance?: boolean;
     }
     /** @public */
-    type InvoiceCollectionRequest = ({
+    type InvoiceCollectionOptionsInput = ({
         customer: Customer;
         payer: 'customer';
     } | {
         otherPayer: string;
         payer: 'other';
-    }) & {
-        collectionSettings: CollectionSettings;
-        parent: Parent;
-    };
+    }) & ({
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | { invoiceParentType: 'cadence' } | { invoiceParentType: 'contract' } | { invoiceParentType: 'quote' } | { invoiceParentType: 'schedule' }) & { collectionOptions: CollectionOptions };
     /** @public */
     interface Customer {
         id: string;
         metadata: Record<string, string>;
     }
+    /** @public */
+    type ContractParent = Record<string, never>;
     /**
-     * The parent resource that triggered the invoice creation.
+     * The Subscription that triggered the invoice creation.
      * @public
      */
-    interface Parent {
-        /** The type of parent resource (for example, subscription or contract). */
-        type: ParentType;
-        /** Custom key-value pairs attached to the parent resource. */
+    interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
         metadata: Record<string, string>;
     }
+    /** @public */
+    type ScheduleParent = Record<string, never>;
+    /** @public */
+    type QuoteParent = Record<string, never>;
+    /** @public */
+    type CadenceParent = Record<string, never>;
     /**
-     * The collection settings for an invoice.
+     * The collection options for an invoice.
      * @public
      */
-    interface CollectionSettings {
+    interface CollectionOptions {
         /** Whether the invoice automatically advances through its lifecycle. */
         autoAdvance: boolean;
         /** The payment collection method: charge_automatically or send_invoice. */
         collectionMethod: CollectionMethod;
-        /** The delay before the invoice is finalized, in hours. */
-        finalizationGracePeriod: number;
         /** The payment methods configured for this invoice. */
         paymentMethods: PaymentMethodType[];
     }
@@ -1093,55 +1100,33 @@ declare namespace InvoiceCollectionSetting {
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    function prepareArgsCollectionOverride(proto: unknown): InvoiceCollectionRequest;
+    function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    function prepareResultCollectionOverride(result: InvoiceCollectionResponse): InvoiceCollectionResponse;
-    /* Excluded from this release type: $platformWrapCollectionOverride */
+    function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
+    /* Excluded from this release type: $platformWrapOverrideOptions */
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    const prepareArgs: typeof prepareArgsCollectionOverride;
+    const prepareArgs: typeof prepareArgsOverrideOptions;
     /**
      * @public
      * @deprecated Platform dispatch handles wire/SDK conversion.
      */
-    const prepareResult: typeof prepareResultCollectionOverride;
+    const prepareResult: typeof prepareResultOverrideOptions;
     /**
-     * Overrides invoice collection settings before a draft invoice is created.
+     * Overrides invoice collection options before a draft invoice is created.
      * @public
      */
-    type CollectionOverrideFunction<Config> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
+    type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
 }
 
-/**
- * @example
- * ```ts
- * import type { Billing, Context } from '@stripe/extensibility-sdk';
- *
- * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
- * interface MyInvoiceCollectionSettingConfig {}
- *
- * export default class MyInvoiceCollectionSetting implements Billing.InvoiceCollectionSetting<MyInvoiceCollectionSettingConfig> {
- *   collectionOverride(
- *     _request: Billing.InvoiceCollectionSetting.InvoiceCollectionRequest,
- *     _config: MyInvoiceCollectionSettingConfig,
- *     _context: Context
- *   ) {
- *     // TODO: implement your collection setting logic here
- *
- *     return {};
- *   }
- * }
- *
- * ```
- * @public
- */
-declare interface InvoiceCollectionSetting<Config> {
-    collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
+/** @public */
+declare interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
 }
 
 /* Excluded from this release type: _isPromiseLike */
@@ -1487,6 +1472,15 @@ declare namespace RecurringBillingItemHandling {
     }
     /** @public */
     type Item = ({
+        creditedItems: 'invoiceItem';
+        invoiceItem: CreditedInvoiceItem;
+    } | {
+        creditedItems: 'invoiceLineItems';
+        invoiceLineItems: InvoiceLineItems;
+    } | {
+        creditedItems: 'other';
+        otherCreditedItems: string;
+    }) & ({
         customPricingUnitOverageRate: CustomPricingUnitOverageRate;
         priceKind: 'customPricingUnitOverageRate';
     } | {
@@ -1508,6 +1502,40 @@ declare namespace RecurringBillingItemHandling {
         servicePeriod: AnyTimeRange;
         type: ItemType;
     };
+    /**
+     * The invoice item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceItem {
+        /** The id of the invoice item. */
+        id: string;
+    }
+    /**
+     * Information about debit line items corresponding to a credit item.
+     * @public
+     */
+    interface InvoiceLineItems {
+        /** The invoice containing the line items. */
+        invoice: CreditedInvoice;
+        /** The line items corresponding to the credit. */
+        invoiceLineItems: CreditedInvoiceLineItem[];
+    }
+    /**
+     * The invoice line item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceLineItem {
+        /** The id of the invoice line item. */
+        id: string;
+    }
+    /**
+     * The invoice corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoice {
+        /** The id of the invoice. */
+        id: string;
+    }
     /** @public */
     interface CustomPricingUnitOverageRate {
         id: string;
@@ -1768,9 +1796,6 @@ export declare type Ref<T extends {
     readonly [__stripeType]: 'string';
 };
 
-/** Factory for creating {@link (Ref:type)} values from an object with `object` and `id` fields. @public */
-export declare const Ref: { create: <T extends { readonly object: string }>(step: { readonly id: string } & T) => Ref<T> };
-
 /* Excluded from this release type: _required */
 
 /**
@@ -1820,7 +1845,7 @@ declare interface TimeRange {
  *
  * @example
  * ```typescript
- * import { toConst } from '@stripe/extensibility-sdk/stdlib';
+ * import { toConst } from '@stripe/extensibility-sdk';
  *
  * const DEFAULTS = toConst({ timeout: 30, retries: 3 });
  * // Type: { readonly timeout: 30; readonly retries: 3 }

package/dist/extensions/billing/index.d.ts

@@ -1,7 +1,7 @@
 export * from './types.js';
 import * as Bill from './bill/index.js';
 export { CustomerBalanceApplication } from './customer_balance_application.js';
-export { InvoiceCollectionSetting } from './invoice_collection_setting.js';
+export { InvoiceCollectionOptions } from './invoice_collection_options.js';
 export { Prorations } from './prorations.js';
 export { RecurringBillingItemHandling } from './recurring_billing_item_handling.js';
 export { Bill };

package/dist/extensions/billing/invoice_collection_options.d.ts

@@ -0,0 +1,111 @@
+import type { Context } from '../context.js';
+import type { _ConfigApplicationContext } from '../../stdlib/index.js';
+/** @public */
+export declare namespace InvoiceCollectionOptions {
+    /** @public */
+    type PaymentMethodType = 'card' | 'ach_debit' | 'ach_credit_transfer' | 'sepa_debit' | 'sepa_credit_transfer' | 'bacs_debit' | 'au_becs_debit' | 'us_bank_account' | 'link' | 'boleto' | 'oxxo' | 'ideal' | 'bancontact' | 'giropay' | 'eps' | 'p24' | 'sofort' | 'alipay' | 'wechat_pay' | 'klarna' | 'affirm' | 'afterpay_clearpay' | 'cashapp' | 'paypal' | 'multibanco' | 'konbini' | 'promptpay' | 'paynow' | 'grabpay' | 'fpx' | 'blik';
+    /** @public */
+    type CollectionMethod = 'send_invoice' | 'charge_automatically';
+    /**
+     * The result of the invoice collection options override extension.
+     * @public
+     */
+    interface InvoiceCollectionOptionsResult {
+        /** Override the auto-advancement setting. Set to false to keep the invoice in draft. Return null to use the default. */
+        autoAdvance?: boolean;
+    }
+    /** @public */
+    type InvoiceCollectionOptionsInput = {
+        /** The current collection options that would be applied to the invoice. */
+        collectionOptions: CollectionOptions;
+    } & ({
+        invoiceParentType: 'cadence';
+    } | {
+        invoiceParentType: 'quote';
+    } | {
+        invoiceParentType: 'schedule';
+    } | {
+        invoiceParentType: 'subscription';
+        subscription: SubscriptionParent;
+    } | {
+        invoiceParentType: 'contract';
+    } | {
+        invoiceParentType: 'other';
+        otherInvoiceParentType: string;
+    }) & ({
+        payer: 'customer';
+        customer: Customer;
+    } | {
+        payer: 'other';
+        otherPayer: string;
+    });
+    /** @public */
+    interface Customer {
+        id: string;
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    type ContractParent = Record<string, never>;
+    /**
+     * The Subscription that triggered the invoice creation.
+     * @public
+     */
+    interface SubscriptionParent {
+        /** The unique identifier for the subscription. */
+        id: string;
+        /** The metadata of the subscription. */
+        metadata: Record<string, string>;
+    }
+    /** @public */
+    type ScheduleParent = Record<string, never>;
+    /** @public */
+    type QuoteParent = Record<string, never>;
+    /** @public */
+    type CadenceParent = Record<string, never>;
+    /**
+     * The collection options for an invoice.
+     * @public
+     */
+    interface CollectionOptions {
+        /** Whether the invoice automatically advances through its lifecycle. */
+        autoAdvance: boolean;
+        /** The payment collection method: charge_automatically or send_invoice. */
+        collectionMethod: CollectionMethod;
+        /** The payment methods configured for this invoice. */
+        paymentMethods: PaymentMethodType[];
+    }
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareArgsOverrideOptions(proto: unknown): InvoiceCollectionOptionsInput;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareResultOverrideOptions(result: InvoiceCollectionOptionsResult): InvoiceCollectionOptionsResult;
+    /** @internal */
+    function $platformWrapOverrideOptions(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
+        overrideOptions(...a: unknown[]): unknown;
+    }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareArgs: typeof prepareArgsOverrideOptions;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareResult: typeof prepareResultOverrideOptions;
+    /**
+     * Overrides invoice collection options before a draft invoice is created.
+     * @public
+     */
+    type OverrideOptionsFunction<Config> = (request: InvoiceCollectionOptionsInput, config: Config, context: Context) => InvoiceCollectionOptionsResult;
+}
+/** @public */
+export interface InvoiceCollectionOptions<Config> {
+    overrideOptions: InvoiceCollectionOptions.OverrideOptionsFunction<Config>;
+}
+//# sourceMappingURL=invoice_collection_options.d.ts.map

package/dist/extensions/billing/invoice_collection_options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice_collection_options.d.ts","sourceRoot":"","sources":["../../../src/extensions/billing/invoice_collection_options.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAEV,yBAAyB,EAI1B,MAAM,uBAAuB,CAAC;AAwB/B,cAAc;AACd,yBAAiB,wBAAwB,CAAC;IACxC,cAAc;IACd,KAAY,iBAAiB,GACzB,MAAM,GACN,WAAW,GACX,qBAAqB,GACrB,YAAY,GACZ,sBAAsB,GACtB,YAAY,GACZ,eAAe,GACf,iBAAiB,GACjB,MAAM,GACN,QAAQ,GACR,MAAM,GACN,OAAO,GACP,YAAY,GACZ,SAAS,GACT,KAAK,GACL,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,mBAAmB,GACnB,SAAS,GACT,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,WAAW,GACX,QAAQ,GACR,SAAS,GACT,KAAK,GACL,MAAM,CAAC;IAEX,cAAc;IACd,KAAY,gBAAgB,GAAG,cAAc,GAAG,sBAAsB,CAAC;IAEvE;;;OAGG;IACH,UAAiB,8BAA8B;QAC7C,wHAAwH;QACxH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,cAAc;IACd,KAAY,6BAA6B,GAAG;QAC1C,2EAA2E;QAC3E,iBAAiB,EAAE,iBAAiB,CAAC;KACtC,GAAG,CACA;QAAE,iBAAiB,EAAE,SAAS,CAAA;KAAE,GAChC;QAAE,iBAAiB,EAAE,OAAO,CAAA;KAAE,GAC9B;QAAE,iBAAiB,EAAE,UAAU,CAAA;KAAE,GACjC;QAAE,iBAAiB,EAAE,cAAc,CAAC;QAAC,YAAY,EAAE,kBAAkB,CAAA;KAAE,GACvE;QAAE,iBAAiB,EAAE,UAAU,CAAA;KAAE,GACjC;QAAE,iBAAiB,EAAE,OAAO,CAAC;QAAC,sBAAsB,EAAE,MAAM,CAAA;KAAE,CACjE,GACC,CAAC;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,GAAG;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAEvF,cAAc;IACd,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED,cAAc;IACd,KAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEnD;;;OAGG;IACH,UAAiB,kBAAkB;QACjC,kDAAkD;QAClD,EAAE,EAAE,MAAM,CAAC;QACX,wCAAwC;QACxC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED,cAAc;IACd,KAAY,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEnD,cAAc;IACd,KAAY,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAEhD,cAAc;IACd,KAAY,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAElD;;;OAGG;IACH,UAAiB,iBAAiB;QAChC,wEAAwE;QACxE,WAAW,EAAE,OAAO,CAAC;QACrB,2EAA2E;QAC3E,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,uDAAuD;QACvD,cAAc,EAAE,iBAAiB,EAAE,CAAC;KACrC;IA+HD;;;OAGG;IACH,SAAgB,0BAA0B,CACxC,KAAK,EAAE,OAAO,GACb,6BAA6B,CAW/B;IAED;;;OAGG;IACH,SAAgB,4BAA4B,CAC1C,MAAM,EAAE,8BAA8B,GACrC,8BAA8B,CAQhC;IAED,gBAAgB;IAChB,SAAgB,4BAA4B,CAC1C,iBAAiB,CAAC,EAAE,CAClB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,GACX,CACD,GAAG,EAAE,UAAU;QAAE,eAAe,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;KAAE,EAC5D,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,EAAE,OAAO,KACT,OAAO,CAkCX;IAID;;;OAGG;IACI,MAAM,WAAW,mCAAoB,CAAC;IAG7C;;;OAGG;IACI,MAAM,aAAa,qCAAsB,CAAC;IAEjD;;;OAGG;IACH,KAAY,uBAAuB,CAAC,MAAM,IAAI,CAC5C,OAAO,EAAE,6BAA6B,EACtC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KACb,8BAA8B,CAAC;CACrC;AAED,cAAc;AACd,MAAM,WAAW,wBAAwB,CAAC,MAAM;IAC9C,eAAe,EAAE,wBAAwB,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;CAC3E"}

package/dist/extensions/billing/recurring_billing_item_handling.d.ts

@@ -76,7 +76,50 @@ export declare namespace RecurringBillingItemHandling {
     } | {
         priceKind: 'other';
         otherPriceKind: string;
+    }) & ({
+        creditedItems: 'invoiceLineItems';
+        invoiceLineItems: InvoiceLineItems;
+    } | {
+        creditedItems: 'invoiceItem';
+        invoiceItem: CreditedInvoiceItem;
+    } | {
+        creditedItems: 'other';
+        otherCreditedItems: string;
     });
+    /**
+     * The invoice item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceItem {
+        /** The id of the invoice item. */
+        id: string;
+    }
+    /**
+     * Information about debit line items corresponding to a credit item.
+     * @public
+     */
+    interface InvoiceLineItems {
+        /** The invoice containing the line items. */
+        invoice: CreditedInvoice;
+        /** The line items corresponding to the credit. */
+        invoiceLineItems: CreditedInvoiceLineItem[];
+    }
+    /**
+     * The invoice line item corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoiceLineItem {
+        /** The id of the invoice line item. */
+        id: string;
+    }
+    /**
+     * The invoice corresponding to a credit item.
+     * @public
+     */
+    interface CreditedInvoice {
+        /** The id of the invoice. */
+        id: string;
+    }
     /** @public */
     interface CustomPricingUnitOverageRate {
         id: string;