@stripe/extensibility-sdk 0.22.4

package/dist/extensions/billing/bill/discount_calculation.d.ts

@@ -0,0 +1,226 @@
+import type { Context } from '../../context.js';
+import type { AnyTimeRange, MonetaryAmount } from '../types.js';
+import type { Decimal, _ConfigApplicationContext } from '../../../stdlib/index.js';
+/** @public */
+export declare namespace DiscountCalculation {
+    /** @public */
+    type BillingReason = 'automatic_pending_invoice_item_invoice' | 'manual' | 'subscription' | 'subscription_create' | 'subscription_cycle' | 'subscription_cancel' | 'subscription_threshold' | 'subscription_trial_ended' | 'subscription_update' | 'upcoming' | 'quote_accept';
+    /** @public */
+    type PricingTierMode = 'graduated' | 'volume';
+    /** @public */
+    type PriceType = 'one_time' | 'recurring';
+    /** @public */
+    type PricingScheme = 'per_unit' | 'tiered';
+    /** @public */
+    type UsageType = 'licensed' | 'metered';
+    /** @public */
+    type RecurringPriceInterval = 'day' | 'week' | 'month' | 'year';
+    /**
+     * The result of a discount calculation.
+     * @public
+     */
+    interface DiscountResult {
+        /** The computed discount to apply. */
+        discount: Discount;
+    }
+    /**
+     * A discount to apply to a discountable item.
+     * @public
+     */
+    interface Discount {
+        /** The discount amount to subtract from the discountable item. */
+        amount: MonetaryAmount;
+    }
+    /**
+     * An item eligible for discount calculation, containing its line items and billing context.
+     * @public
+     */
+    interface DiscountableItem {
+        /** The individual line items that make up the discountable item. */
+        lineItems: DiscountableLineItem[];
+        /** The total gross amount of the discountable item before any discounts. */
+        grossAmount: MonetaryAmount;
+        /** The customer associated with the discountable item. */
+        customer?: Customer;
+        /** The reason this item is being billed. */
+        billingReason?: BillingReason;
+        /** The subscription associated with the discountable item. */
+        subscription?: Subscription;
+    }
+    /**
+     * The subscription associated with the discountable item.
+     * @public
+     */
+    interface Subscription {
+        /** The unique identifier of the subscription. */
+        id: string;
+        /** The Unix timestamp of the billing cycle anchor. */
+        billingCycleAnchor?: number;
+        /** The structured billing cycle anchor configuration. */
+        billingCycleAnchorConfig?: BillingCycleAnchorConfig;
+        /** Custom key-value pairs attached to the subscription. */
+        metadata: Record<string, string>;
+    }
+    /**
+     * Configuration for the billing cycle anchor, specifying when recurring billing periods start.
+     * @public
+     */
+    interface BillingCycleAnchorConfig {
+        /** The month component of the billing cycle anchor. */
+        month: number;
+        /** The day of the month for the billing cycle anchor. */
+        dayOfMonth: number;
+        /** The hour component of the billing cycle anchor. */
+        hour: number;
+        /** The minute component of the billing cycle anchor. */
+        minute: number;
+        /** The second component of the billing cycle anchor. */
+        second: number;
+    }
+    /**
+     * The customer associated with the discountable item.
+     * @public
+     */
+    interface Customer {
+        /** The unique identifier of the customer. */
+        id: string;
+        /** Custom key-value pairs attached to the customer. */
+        metadata: Record<string, string>;
+    }
+    /**
+     * A single line item within a discountable item.
+     * @public
+     */
+    interface DiscountableLineItem {
+        /** The subtotal amount of this line item. */
+        subtotal: MonetaryAmount;
+        /** The quantity of this line item. */
+        quantity?: Decimal;
+        /** The billing period this line item covers. */
+        period: AnyTimeRange;
+        /** The price information for this line item. */
+        price?: Price;
+    }
+    /**
+     * The price associated with a line item.
+     * @public
+     */
+    interface Price {
+        /** The unique identifier for the price. */
+        id: string;
+        /** The product this price belongs to. */
+        product?: Product;
+        /** The recurring pricing configuration, if applicable. */
+        recurring?: RecurringPrice;
+        /** The billing scheme, either per-unit or tiered. */
+        billingScheme?: PricingScheme;
+        /** The pricing tiers, applicable for tiered billing schemes. */
+        tiers: PriceTier[];
+        /** The price type, either one-time or recurring. */
+        type?: PriceType;
+        /** The tiering mode, either graduated or volume. */
+        tiersMode?: PricingTierMode;
+        /** Key-value metadata attached to the price. */
+        metadata: Record<string, string>;
+        /** The unit amount of the price. */
+        unitAmount?: Decimal;
+    }
+    /**
+     * A tier within a tiered pricing structure.
+     * @public
+     */
+    interface PriceTier {
+        /** The flat fee charged for this tier. */
+        flatAmount?: Decimal;
+        /** The per-unit price for this tier. */
+        unitAmount?: Decimal;
+        /** The upper bound of the tier range. */
+        upTo?: Decimal;
+    }
+    /**
+     * The recurring pricing configuration for a price.
+     * @public
+     */
+    interface RecurringPrice {
+        /** The billing interval for the recurring price. */
+        interval: RecurringPriceInterval;
+        /** The number of intervals between each billing cycle. */
+        intervalCount: number;
+        /** The usage type, either licensed or metered. */
+        usageType?: UsageType;
+        /** The identifier of the meter tracking usage for this price. */
+        meter?: string;
+    }
+    /**
+     * The product associated with a price.
+     * @public
+     */
+    interface Product {
+        /** The unique identifier of the product. */
+        id: string;
+        /** The name of the product. */
+        name: string;
+        /** Custom key-value pairs attached to the product. */
+        metadata: Record<string, string>;
+    }
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareArgsComputeDiscounts(proto: unknown): DiscountableItem;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareResultComputeDiscounts(result: DiscountResult): DiscountResult;
+    /** @internal */
+    function $platformWrapComputeDiscounts(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
+        computeDiscounts(...a: unknown[]): unknown;
+    }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareArgs: typeof prepareArgsComputeDiscounts;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareResult: typeof prepareResultComputeDiscounts;
+    /**
+     * Computes discount amounts for a discountable item and returns a discount result.
+     * @public
+     */
+    type ComputeDiscountsFunction<Config extends Record<string, unknown>> = (request: DiscountableItem, config: Config, context: Context) => DiscountResult;
+}
+/**
+ * @example
+ * ```ts
+ * import type { Billing } from '@stripe/extensibility-sdk/extensions';
+ * import type { Context } from '@stripe/extensibility-sdk/extensions';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyDiscountCalculationConfig extends Record<string, unknown> {}
+ *
+ * export default class MyDiscountCalculation implements Billing.Bill
+ *   .DiscountCalculation<MyDiscountCalculationConfig> {
+ *   computeDiscounts(
+ *     request: Billing.Bill.DiscountCalculation.DiscountableItem,
+ *     _config: MyDiscountCalculationConfig,
+ *     _context: Context
+ *   ) {
+ *     // TODO: implement your discount logic here
+ *
+ *     return {
+ *       discount: { amount: request.grossAmount },
+ *     };
+ *   }
+ * }
+ *
+ * ```
+ * @public
+ */
+export interface DiscountCalculation<Config extends Record<string, unknown>> {
+    computeDiscounts: DiscountCalculation.ComputeDiscountsFunction<Config>;
+}
+//# sourceMappingURL=discount_calculation.d.ts.map

package/dist/extensions/billing/bill/discount_calculation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"discount_calculation.d.ts","sourceRoot":"","sources":["../../../../src/extensions/billing/bill/discount_calculation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEhE,OAAO,KAAK,EACV,OAAO,EACP,yBAAyB,EAI1B,MAAM,0BAA0B,CAAC;AAwBlC,cAAc;AACd,yBAAiB,mBAAmB,CAAC;IACnC,cAAc;IACd,KAAY,aAAa,GACrB,wCAAwC,GACxC,QAAQ,GACR,cAAc,GACd,qBAAqB,GACrB,oBAAoB,GACpB,qBAAqB,GACrB,wBAAwB,GACxB,0BAA0B,GAC1B,qBAAqB,GACrB,UAAU,GACV,cAAc,CAAC;IAEnB,cAAc;IACd,KAAY,eAAe,GAAG,WAAW,GAAG,QAAQ,CAAC;IAErD,cAAc;IACd,KAAY,SAAS,GAAG,UAAU,GAAG,WAAW,CAAC;IAEjD,cAAc;IACd,KAAY,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;IAElD,cAAc;IACd,KAAY,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;IAE/C,cAAc;IACd,KAAY,sBAAsB,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAEvE;;;OAGG;IACH,UAAiB,cAAc;QAC7B,sCAAsC;QACtC,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED;;;OAGG;IACH,UAAiB,QAAQ;QACvB,kEAAkE;QAClE,MAAM,EAAE,cAAc,CAAC;KACxB;IAED;;;OAGG;IACH,UAAiB,gBAAgB;QAC/B,oEAAoE;QACpE,SAAS,EAAE,oBAAoB,EAAE,CAAC;QAClC,4EAA4E;QAC5E,WAAW,EAAE,cAAc,CAAC;QAC5B,0DAA0D;QAC1D,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB,4CAA4C;QAC5C,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,8DAA8D;QAC9D,YAAY,CAAC,EAAE,YAAY,CAAC;KAC7B;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B,iDAAiD;QACjD,EAAE,EAAE,MAAM,CAAC;QACX,sDAAsD;QACtD,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,yDAAyD;QACzD,wBAAwB,CAAC,EAAE,wBAAwB,CAAC;QACpD,2DAA2D;QAC3D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,wBAAwB;QACvC,uDAAuD;QACvD,KAAK,EAAE,MAAM,CAAC;QACd,yDAAyD;QACzD,UAAU,EAAE,MAAM,CAAC;QACnB,sDAAsD;QACtD,IAAI,EAAE,MAAM,CAAC;QACb,wDAAwD;QACxD,MAAM,EAAE,MAAM,CAAC;QACf,wDAAwD;QACxD,MAAM,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,QAAQ;QACvB,6CAA6C;QAC7C,EAAE,EAAE,MAAM,CAAC;QACX,uDAAuD;QACvD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,oBAAoB;QACnC,6CAA6C;QAC7C,QAAQ,EAAE,cAAc,CAAC;QACzB,sCAAsC;QACtC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,gDAAgD;QAChD,MAAM,EAAE,YAAY,CAAC;QACrB,gDAAgD;QAChD,KAAK,CAAC,EAAE,KAAK,CAAC;KACf;IAED;;;OAGG;IACH,UAAiB,KAAK;QACpB,2CAA2C;QAC3C,EAAE,EAAE,MAAM,CAAC;QACX,yCAAyC;QACzC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,0DAA0D;QAC1D,SAAS,CAAC,EAAE,cAAc,CAAC;QAC3B,qDAAqD;QACrD,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,gEAAgE;QAChE,KAAK,EAAE,SAAS,EAAE,CAAC;QACnB,oDAAoD;QACpD,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,oDAAoD;QACpD,SAAS,CAAC,EAAE,eAAe,CAAC;QAC5B,gDAAgD;QAChD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjC,oCAAoC;QACpC,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;IAED;;;OAGG;IACH,UAAiB,SAAS;QACxB,0CAA0C;QAC1C,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,wCAAwC;QACxC,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,yCAAyC;QACzC,IAAI,CAAC,EAAE,OAAO,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,cAAc;QAC7B,oDAAoD;QACpD,QAAQ,EAAE,sBAAsB,CAAC;QACjC,0DAA0D;QAC1D,aAAa,EAAE,MAAM,CAAC;QACtB,kDAAkD;QAClD,SAAS,CAAC,EAAE,SAAS,CAAC;QACtB,iEAAiE;QACjE,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;;OAGG;IACH,UAAiB,OAAO;QACtB,4CAA4C;QAC5C,EAAE,EAAE,MAAM,CAAC;QACX,+BAA+B;QAC/B,IAAI,EAAE,MAAM,CAAC;QACb,sDAAsD;QACtD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IA+ZD;;;OAGG;IACH,SAAgB,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,gBAAgB,CAW5E;IAED;;;OAGG;IACH,SAAgB,6BAA6B,CAAC,MAAM,EAAE,cAAc,GAAG,cAAc,CAQpF;IAED,gBAAgB;IAChB,SAAgB,6BAA6B,CAC3C,iBAAiB,CAAC,EAAE,CAClB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,GACX,CACD,GAAG,EAAE,UAAU;QAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;KAAE,EAC7D,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,EAAE,OAAO,KACT,OAAO,CA0BX;IAID;;;OAGG;IACI,MAAM,WAAW,oCAAoB,CAAC;IAG7C;;;OAGG;IACI,MAAM,aAAa,sCAAsB,CAAC;IAEjD;;;OAGG;IACH,KAAY,wBAAwB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAC7E,OAAO,EAAE,gBAAgB,EACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KACb,cAAc,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,mBAAmB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzE,gBAAgB,EAAE,mBAAmB,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC;CACxE"}

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

@@ -0,0 +1,2 @@
+export * from './discount_calculation.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/extensions/billing/bill/index.ts"],"names":[],"mappings":"AAEA,cAAc,2BAA2B,CAAC"}

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

@@ -0,0 +1,82 @@
+import type { Context } from '../context.js';
+import type { MonetaryAmount } from './types.js';
+import type { _ConfigApplicationContext } from '../../stdlib/index.js';
+/** @public */
+export declare namespace CustomerBalanceApplication {
+    /**
+     * The result of computing how much customer balance to apply to a bill.
+     * @public
+     */
+    interface CustomerBalanceApplicationResult {
+        /** The amount of customer balance to apply to this invoice. Positive values increase the invoice amount (applying a debit), negative values decrease it (applying a credit). Set to zero to apply no balance. */
+        appliedCustomerBalance: MonetaryAmount;
+    }
+    /**
+     * The bill details provided as input to the customer balance application extension.
+     * @public
+     */
+    interface CustomerBalanceApplicationInput {
+        /** The total amount of the invoice before applying any customer balance. */
+        totalAmount: MonetaryAmount;
+        /** The current customer balance available to apply. Positive values indicate debits (the customer owes money), negative values indicate credits. */
+        customerBalance: MonetaryAmount;
+    }
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareArgsComputeAppliedCustomerBalance(proto: unknown): CustomerBalanceApplicationInput;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareResultComputeAppliedCustomerBalance(result: CustomerBalanceApplicationResult): CustomerBalanceApplicationResult;
+    /** @internal */
+    function $platformWrapComputeAppliedCustomerBalance(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
+        computeAppliedCustomerBalance(...a: unknown[]): unknown;
+    }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareArgs: typeof prepareArgsComputeAppliedCustomerBalance;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareResult: typeof prepareResultComputeAppliedCustomerBalance;
+    /**
+     * Determines how much of the customer's balance to apply toward a bill total. The script receives the invoice total and current customer balance, then returns how much of that balance to apply.
+     * @public
+     */
+    type ComputeAppliedCustomerBalanceFunction<Config extends Record<string, unknown>> = (request: CustomerBalanceApplicationInput, config: Config, context: Context) => CustomerBalanceApplicationResult;
+}
+/**
+ * @example
+ * ```ts
+ * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyCustomerBalanceApplicationConfig extends Record<string, unknown> {}
+ *
+ * export default class MyCustomerBalanceApplication implements Billing.CustomerBalanceApplication<MyCustomerBalanceApplicationConfig> {
+ *   computeAppliedCustomerBalance(
+ *     request: Billing.CustomerBalanceApplication.CustomerBalanceApplicationInput,
+ *     _config: MyCustomerBalanceApplicationConfig,
+ *     _context: Context
+ *   ) {
+ *     // TODO: implement your customer balance logic here
+ *
+ *     return {
+ *       appliedCustomerBalance: request.customerBalance,
+ *     };
+ *   }
+ * }
+ *
+ * ```
+ * @public
+ */
+export interface CustomerBalanceApplication<Config extends Record<string, unknown>> {
+    computeAppliedCustomerBalance: CustomerBalanceApplication.ComputeAppliedCustomerBalanceFunction<Config>;
+}
+//# sourceMappingURL=customer_balance_application.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customer_balance_application.d.ts","sourceRoot":"","sources":["../../../src/extensions/billing/customer_balance_application.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,KAAK,EAEV,yBAAyB,EAI1B,MAAM,uBAAuB,CAAC;AAwB/B,cAAc;AACd,yBAAiB,0BAA0B,CAAC;IAC1C;;;OAGG;IACH,UAAiB,gCAAgC;QAC/C,iNAAiN;QACjN,sBAAsB,EAAE,cAAc,CAAC;KACxC;IAED;;;OAGG;IACH,UAAiB,+BAA+B;QAC9C,4EAA4E;QAC5E,WAAW,EAAE,cAAc,CAAC;QAC5B,oJAAoJ;QACpJ,eAAe,EAAE,cAAc,CAAC;KACjC;IA2PD;;;OAGG;IACH,SAAgB,wCAAwC,CACtD,KAAK,EAAE,OAAO,GACb,+BAA+B,CAWjC;IAED;;;OAGG;IACH,SAAgB,0CAA0C,CACxD,MAAM,EAAE,gCAAgC,GACvC,gCAAgC,CAQlC;IAED,gBAAgB;IAChB,SAAgB,0CAA0C,CACxD,iBAAiB,CAAC,EAAE,CAClB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,GACX,CACD,GAAG,EAAE,UAAU;QAAE,6BAA6B,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;KAAE,EAC1E,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,EAAE,OAAO,KACT,OAAO,CAkCX;IAID;;;OAGG;IACI,MAAM,WAAW,iDAAoB,CAAC;IAG7C;;;OAGG;IACI,MAAM,aAAa,mDAAsB,CAAC;IAEjD;;;OAGG;IACH,KAAY,qCAAqC,CAC/C,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpC,CACF,OAAO,EAAE,+BAA+B,EACxC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KACb,gCAAgC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,0BAA0B,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAChF,6BAA6B,EAAE,0BAA0B,CAAC,qCAAqC,CAAC,MAAM,CAAC,CAAC;CACzG"}

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

@@ -0,0 +1,8 @@
+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 { Prorations } from './prorations.js';
+export { RecurringBillingItemHandling } from './recurring_billing_item_handling.js';
+export { Bill };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/extensions/billing/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAC;AAC3B,OAAO,KAAK,IAAI,MAAM,iBAAiB,CAAC;AACxC,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,IAAI,EAAE,CAAC"}

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

@@ -0,0 +1,117 @@
+import type { Context } from '../context.js';
+import type { _ConfigApplicationContext } from '../../stdlib/index.js';
+/** @public */
+export declare namespace InvoiceCollectionSetting {
+    /** @public */
+    type ParentType = 'subscription' | 'contract' | 'quote' | 'billing_cadence' | 'subscription_schedule' | 'standalone';
+    /** @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';
+    /** @public */
+    type CollectionMethod = 'send_invoice' | 'charge_automatically';
+    /**
+     * The result of the invoice collection settings override extension.
+     * @public
+     */
+    interface InvoiceCollectionResponse {
+        /** 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 = {
+        /** The current collection settings that would be applied to the invoice. */
+        collectionSettings: CollectionSettings;
+        /** The billing resource that triggered invoice creation. */
+        parent: Parent;
+    } & ({
+        payer: 'customer';
+        customer: Customer;
+    } | {
+        payer: 'other';
+        otherPayer: string;
+    });
+    /** @public */
+    interface Customer {
+        id: string;
+        metadata: Record<string, string>;
+    }
+    /**
+     * The parent resource 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. */
+        metadata: Record<string, string>;
+    }
+    /**
+     * The collection settings for an invoice.
+     * @public
+     */
+    interface CollectionSettings {
+        /** 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[];
+    }
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareArgsCollectionOverride(proto: unknown): InvoiceCollectionRequest;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    function prepareResultCollectionOverride(result: InvoiceCollectionResponse): InvoiceCollectionResponse;
+    /** @internal */
+    function $platformWrapCollectionOverride(configTransformer?: (wireConfig: unknown, appCtx: _ConfigApplicationContext) => unknown): (cls: new () => {
+        collectionOverride(...a: unknown[]): unknown;
+    }, wireArgs: unknown, wireConfig: unknown, ctx: unknown) => unknown;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareArgs: typeof prepareArgsCollectionOverride;
+    /**
+     * @public
+     * @deprecated Platform dispatch handles wire/SDK conversion.
+     */
+    const prepareResult: typeof prepareResultCollectionOverride;
+    /**
+     * Overrides invoice collection settings before a draft invoice is created.
+     * @public
+     */
+    type CollectionOverrideFunction<Config extends Record<string, unknown>> = (request: InvoiceCollectionRequest, config: Config, context: Context) => InvoiceCollectionResponse;
+}
+/**
+ * @example
+ * ```ts
+ * import type { Billing, Context } from '@stripe/extensibility-sdk/extensions';
+ *
+ * // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+ * interface MyInvoiceCollectionSettingConfig extends Record<string, unknown> {}
+ *
+ * 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
+ */
+export interface InvoiceCollectionSetting<Config extends Record<string, unknown>> {
+    collectionOverride: InvoiceCollectionSetting.CollectionOverrideFunction<Config>;
+}
+//# sourceMappingURL=invoice_collection_setting.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"invoice_collection_setting.d.ts","sourceRoot":"","sources":["../../../src/extensions/billing/invoice_collection_setting.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,UAAU,GAClB,cAAc,GACd,UAAU,GACV,OAAO,GACP,iBAAiB,GACjB,uBAAuB,GACvB,YAAY,CAAC;IAEjB,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,CAAC;IAEV,cAAc;IACd,KAAY,gBAAgB,GAAG,cAAc,GAAG,sBAAsB,CAAC;IAEvE;;;OAGG;IACH,UAAiB,yBAAyB;QACxC,wHAAwH;QACxH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,cAAc;IACd,KAAY,wBAAwB,GAAG;QACrC,4EAA4E;QAC5E,kBAAkB,EAAE,kBAAkB,CAAC;QACvC,4DAA4D;QAC5D,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,CACA;QAAE,KAAK,EAAE,UAAU,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAA;KAAE,GACzC;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CACzC,CAAC;IAEF,cAAc;IACd,UAAiB,QAAQ;QACvB,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,MAAM;QACrB,2EAA2E;QAC3E,IAAI,EAAE,UAAU,CAAC;QACjB,8DAA8D;QAC9D,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,kBAAkB;QACjC,wEAAwE;QACxE,WAAW,EAAE,OAAO,CAAC;QACrB,2EAA2E;QAC3E,gBAAgB,EAAE,gBAAgB,CAAC;QACnC,2DAA2D;QAC3D,uBAAuB,EAAE,MAAM,CAAC;QAChC,uDAAuD;QACvD,cAAc,EAAE,iBAAiB,EAAE,CAAC;KACrC;IAuHD;;;OAGG;IACH,SAAgB,6BAA6B,CAC3C,KAAK,EAAE,OAAO,GACb,wBAAwB,CAW1B;IAED;;;OAGG;IACH,SAAgB,+BAA+B,CAC7C,MAAM,EAAE,yBAAyB,GAChC,yBAAyB,CAQ3B;IAED,gBAAgB;IAChB,SAAgB,+BAA+B,CAC7C,iBAAiB,CAAC,EAAE,CAClB,UAAU,EAAE,OAAO,EACnB,MAAM,EAAE,yBAAyB,KAC9B,OAAO,GACX,CACD,GAAG,EAAE,UAAU;QAAE,kBAAkB,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;KAAE,EAC/D,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,OAAO,EACnB,GAAG,EAAE,OAAO,KACT,OAAO,CA0BX;IAID;;;OAGG;IACI,MAAM,WAAW,sCAAoB,CAAC;IAG7C;;;OAGG;IACI,MAAM,aAAa,wCAAsB,CAAC;IAEjD;;;OAGG;IACH,KAAY,0BAA0B,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,CAC/E,OAAO,EAAE,wBAAwB,EACjC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,OAAO,KACb,yBAAyB,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,wBAAwB,CAAC,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC9E,kBAAkB,EAAE,wBAAwB,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;CACjF"}