stripe 22.2.0 → 22.3.0-alpha.2

package/esm/resources/InvoiceItems.d.ts

@@ -2,6 +2,7 @@ import { StripeResource } from '../StripeResource.js';
 import { Discount, DeletedDiscount } from './Discounts.js';
 import { Customer, DeletedCustomer } from './Customers.js';
 import { Invoice } from './Invoices.js';
+import { Margin } from './Margins.js';
 import { TaxRate } from './TaxRates.js';
 import { Price } from './Prices.js';
 import * as TestHelpers from './TestHelpers/index.js';
@@ -28,6 +29,18 @@ export declare class InvoiceItemResource extends StripeResource {
      * Creates an item to be added to a draft invoice (up to 250 items per invoice). If no invoice is specified, the item will be on the next invoice created for the customer specified.
      */
     create(params?: InvoiceItemCreateParams, options?: RequestOptions): Promise<Response<InvoiceItem>>;
+    serializeBatchDelete(invoiceitem: string, params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
+    serializeBatchUpdate(invoiceitem: string, params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
+    serializeBatchCreate(params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
 }
 export interface InvoiceItem {
     /**
@@ -74,6 +87,10 @@ export interface InvoiceItem {
      * The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
      */
     discounts: Array<string | Discount> | null;
+    /**
+     * Array of field names that can't be modified. Attempting to update a frozen field returns an error.
+     */
+    frozen_fields?: Array<InvoiceItem.FrozenField>;
     /**
      * The ID of the invoice this invoice item belongs to.
      */
@@ -82,6 +99,10 @@ export interface InvoiceItem {
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
     livemode: boolean;
+    /**
+     * The margins which apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+     */
+    margins?: Array<string | Margin> | null;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
      */
@@ -136,7 +157,20 @@ export interface DeletedInvoiceItem {
     deleted: true;
 }
 export declare namespace InvoiceItem {
+    type FrozenField = 'discounts' | 'pricing' | 'quantity';
     interface Parent {
+        /**
+         * Details about the pricing plan subscription that generated this invoice item
+         */
+        pricing_plan_subscription_details?: Parent.PricingPlanSubscriptionDetails | null;
+        /**
+         * Details about the rate card subscription that generated this invoice item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+        /**
+         * Details about the subscription schedule that generated this invoice item
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
         /**
          * Details about the subscription that generated this invoice item
          */
@@ -144,7 +178,7 @@ export declare namespace InvoiceItem {
         /**
          * The type of parent that generated this invoice item
          */
-        type: 'subscription_details';
+        type: Parent.Type;
     }
     interface Period {
         /**
@@ -157,11 +191,14 @@ export declare namespace InvoiceItem {
         start: number;
     }
     interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
         price_details?: Pricing.PriceDetails;
+        rate_card_custom_pricing_unit_overage_rate_details?: Pricing.RateCardCustomPricingUnitOverageRateDetails;
+        rate_card_rate_details?: Pricing.RateCardRateDetails;
         /**
          * The type of the pricing details.
          */
-        type: 'price_details';
+        type: Pricing.Type;
         /**
          * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
          */
@@ -178,6 +215,36 @@ export declare namespace InvoiceItem {
         discount_amounts: Array<ProrationDetails.DiscountAmount>;
     }
     namespace Parent {
+        interface PricingPlanSubscriptionDetails {
+            /**
+             * The pricing plan subscription that manages this charge
+             */
+            pricing_plan_subscription: string;
+            /**
+             * The pricing plan version at the time this charge was generated
+             */
+            pricing_plan_version: string;
+        }
+        interface RateCardSubscriptionDetails {
+            /**
+             * The rate card subscription that generated this invoice item
+             */
+            rate_card_subscription: string;
+            /**
+             * The rate card version that generated this invoice item
+             */
+            rate_card_version: string;
+        }
+        interface ScheduleDetails {
+            /**
+             * The subscription schedule that generated this invoice item
+             */
+            schedule: string;
+            /**
+             * The subscription associated with this schedule
+             */
+            subscription: string | null;
+        }
         interface SubscriptionDetails {
             /**
              * The subscription that generated this invoice item
@@ -188,8 +255,23 @@ export declare namespace InvoiceItem {
              */
             subscription_item?: string;
         }
+        type Type = 'pricing_plan_subscription_details' | 'rate_card_subscription_details' | 'schedule_details' | 'subscription_details';
     }
     namespace Pricing {
+        interface LicenseFeeDetails {
+            /**
+             * The ID of the license fee this item is associated with
+             */
+            license_fee: string;
+            /**
+             * The version of the license fee this item is associated with
+             */
+            license_fee_version: string;
+            /**
+             * The ID of the licensed item this item is associated with
+             */
+            licensed_item: string;
+        }
         interface PriceDetails {
             /**
              * The ID of the price this item is associated with.
@@ -200,6 +282,39 @@ export declare namespace InvoiceItem {
              */
             product: string;
         }
+        interface RateCardCustomPricingUnitOverageRateDetails {
+            /**
+             * The ID of the custom pricing unit this item is associated with
+             */
+            custom_pricing_unit: string;
+            /**
+             * The ID of the custom pricing unit overage rate this item is associated with
+             */
+            custom_pricing_unit_overage_rate: string;
+            /**
+             * The ID of the one-time item this custom pricing unit overage rate is associated with
+             */
+            one_time_item: string;
+            /**
+             * The ID of the rate card this item is associated with
+             */
+            rate_card: string;
+        }
+        interface RateCardRateDetails {
+            /**
+             * The ID of billable item this item is associated with
+             */
+            metered_item: string;
+            /**
+             * The ID of the rate card this item is associated with
+             */
+            rate_card: string;
+            /**
+             * The ID of the rate card rate this item is associated with
+             */
+            rate_card_rate: string;
+        }
+        type Type = 'license_fee_details' | 'price_details' | 'rate_card_custom_pricing_unit_overage_rate_details' | 'rate_card_rate_details';
     }
     namespace ProrationDetails {
         interface CreditedItems {
@@ -275,6 +390,10 @@ export interface InvoiceItemCreateParams {
      * The ID of an existing invoice to add this invoice item to. For subscription invoices, when left blank, the invoice item will be added to the next upcoming scheduled invoice. For standalone invoices, the invoice item won't be automatically added unless you pass `pending_invoice_item_behavior: 'include'` when creating the invoice. This is useful when adding invoice items in response to an invoice.created webhook. You can only add invoice items to draft invoices and there is a maximum of 250 items per invoice.
      */
     invoice?: string;
+    /**
+     * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+     */
+    margins?: Array<string>;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
@@ -330,6 +449,10 @@ export declare namespace InvoiceItemCreateParams {
          * ID of an existing discount on the object (or one of its ancestors) to reuse.
          */
         discount?: string;
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
         /**
          * ID of the promotion code to create a new discount for.
          */
@@ -374,6 +497,38 @@ export declare namespace InvoiceItemCreateParams {
         price?: string;
     }
     type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    namespace Discount {
+        interface DiscountEnd {
+            /**
+             * Time span for the redeemed discount.
+             */
+            duration?: DiscountEnd.Duration;
+            /**
+             * A precise Unix timestamp for the discount to end. Must be in the future.
+             */
+            timestamp?: number;
+            /**
+             * The type of calculation made to determine when the discount ends.
+             */
+            type: DiscountEnd.Type;
+        }
+        namespace DiscountEnd {
+            interface Duration {
+                /**
+                 * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+                 */
+                interval: Duration.Interval;
+                /**
+                 * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+                 */
+                interval_count: number;
+            }
+            type Type = 'duration' | 'timestamp';
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+        }
+    }
     namespace PriceData {
         type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
@@ -405,6 +560,10 @@ export interface InvoiceItemUpdateParams {
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
+    /**
+     * The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
+     */
+    margins?: Emptyable<Array<string>>;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
      */
@@ -456,6 +615,10 @@ export declare namespace InvoiceItemUpdateParams {
          * ID of an existing discount on the object (or one of its ancestors) to reuse.
          */
         discount?: string;
+        /**
+         * Details to determine how long the discount should be applied for.
+         */
+        discount_end?: Discount.DiscountEnd;
         /**
          * ID of the promotion code to create a new discount for.
          */
@@ -500,6 +663,38 @@ export declare namespace InvoiceItemUpdateParams {
         price?: string;
     }
     type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
+    namespace Discount {
+        interface DiscountEnd {
+            /**
+             * Time span for the redeemed discount.
+             */
+            duration?: DiscountEnd.Duration;
+            /**
+             * A precise Unix timestamp for the discount to end. Must be in the future.
+             */
+            timestamp?: number;
+            /**
+             * The type of calculation made to determine when the discount ends.
+             */
+            type: DiscountEnd.Type;
+        }
+        namespace DiscountEnd {
+            interface Duration {
+                /**
+                 * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+                 */
+                interval: Duration.Interval;
+                /**
+                 * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
+                 */
+                interval_count: number;
+            }
+            type Type = 'duration' | 'timestamp';
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+        }
+    }
     namespace PriceData {
         type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
@@ -532,3 +727,9 @@ export interface InvoiceItemListParams extends PaginationParams {
 }
 export interface InvoiceItemDeleteParams {
 }
+export interface InvoiceItemSerializeBatchCreateParams {
+}
+export interface InvoiceItemSerializeBatchDeleteParams {
+}
+export interface InvoiceItemSerializeBatchUpdateParams {
+}

package/esm/resources/InvoiceItems.js

@@ -138,5 +138,46 @@ export class InvoiceItemResource extends StripeResource {
             },
         });
     }
+    serializeBatchDelete(invoiceitem, params = {}, options = {}) {
+        const itemId = this._stripe._platformFunctions.uuid4();
+        const stripeVersion = options.apiVersion || this._stripe.getApiField('version');
+        const entry = {
+            id: itemId,
+            params: params,
+            stripe_version: stripeVersion,
+        };
+        entry.path_params = { invoiceitem: invoiceitem };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
+    serializeBatchUpdate(invoiceitem, params = {}, options = {}) {
+        const itemId = this._stripe._platformFunctions.uuid4();
+        const stripeVersion = options.apiVersion || this._stripe.getApiField('version');
+        const entry = {
+            id: itemId,
+            params: params,
+            stripe_version: stripeVersion,
+        };
+        entry.path_params = { invoiceitem: invoiceitem };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
+    serializeBatchCreate(params = {}, options = {}) {
+        const itemId = this._stripe._platformFunctions.uuid4();
+        const stripeVersion = options.apiVersion || this._stripe.getApiField('version');
+        const entry = {
+            id: itemId,
+            params: params,
+            stripe_version: stripeVersion,
+        };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
 }
 //# sourceMappingURL=InvoiceItems.js.map

package/esm/resources/InvoiceItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvoiceItems.js","sourceRoot":"","sources":["../../src/resources/InvoiceItems.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAiBpD,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;YACzE,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,EACP;YACE,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,EAAC,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,EAAC;qBACxD;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;oBAC1C,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC9C;aACF;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE;YACnE,UAAU,EAAE,MAAM;YAClB,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,OAAO,EAAE;oCACP,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE;4CACN,mBAAmB,EAAE;gDACnB,IAAI,EAAE,UAAU;gDAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;6CAChC;yCACF;qCACF;iCACF;gCACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;6BAC3C;yBACF;qBACF;iBACF;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE;YACpE,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,EAAC,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,EAAC;qBACxD;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;oBAC1C,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC9C;aACF;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;CACF"}
+{"version":3,"file":"InvoiceItems.js","sourceRoot":"","sources":["../../src/resources/InvoiceItems.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAkBpD,MAAM,OAAO,mBAAoB,SAAQ,cAAc;IACrD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,oBAAoB,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE;YACzE,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,EAAE,EAAE,EACxB,MAAM,EACN,OAAO,EACP;YACE,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,EAAC,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,EAAC;qBACxD;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;oBAC1C,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC9C;aACF;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,IAAI,CACF,MAA8B,EAC9B,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE;YACnE,UAAU,EAAE,MAAM;YAClB,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,IAAI,EAAE;wBACJ,IAAI,EAAE,OAAO;wBACb,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,OAAO,EAAE;oCACP,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;wCACd,MAAM,EAAE;4CACN,mBAAmB,EAAE;gDACnB,IAAI,EAAE,UAAU;gDAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;6CAChC;yCACF;qCACF;iCACF;gCACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;6BAC3C;yBACF;qBACF;iBACF;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;IACD;;OAEG;IACH,MAAM,CACJ,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,OAAO,EAAE;YACpE,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,MAAM,EAAE,EAAC,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC,EAAC;qBACxD;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;oBAC1C,mBAAmB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC9C;aACF;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE;oBACN,OAAO,EAAE;wBACP,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,MAAM,EAAE;gCACN,mBAAmB,EAAE;oCACnB,IAAI,EAAE,UAAU;oCAChB,KAAK,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iCAChC;6BACF;yBACF;qBACF;oBACD,gBAAgB,EAAE,EAAC,IAAI,EAAE,gBAAgB,EAAC;iBAC3C;aACF;SACF,CAAQ,CAAC;IACZ,CAAC;IACD,oBAAoB,CAClB,WAAmB,EACnB,SAAkC,EAAE,EACpC,UAAyD,EAAE;QAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACvD,MAAM,aAAa,GACjB,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,KAAK,GAA4B;YACrC,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,aAAa;SAC9B,CAAC;QACF,KAAK,CAAC,WAAW,GAAG,EAAC,WAAW,EAAE,WAAW,EAAC,CAAC;QAC/C,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,oBAAoB,CAClB,WAAmB,EACnB,SAAkC,EAAE,EACpC,UAAyD,EAAE;QAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACvD,MAAM,aAAa,GACjB,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,KAAK,GAA4B;YACrC,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,aAAa;SAC9B,CAAC;QACF,KAAK,CAAC,WAAW,GAAG,EAAC,WAAW,EAAE,WAAW,EAAC,CAAC;QAC/C,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,oBAAoB,CAClB,SAAkC,EAAE,EACpC,UAAyD,EAAE;QAE3D,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAC;QACvD,MAAM,aAAa,GACjB,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAE5D,MAAM,KAAK,GAA4B;YACrC,EAAE,EAAE,MAAM;YACV,MAAM,EAAE,MAAM;YACd,cAAc,EAAE,aAAa;SAC9B,CAAC;QACF,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;SACvC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;CACF"}

package/esm/resources/InvoiceLineItems.d.ts

@@ -1,6 +1,8 @@
 import { Discount, DeletedDiscount } from './Discounts.js';
+import { Margin } from './Margins.js';
 import { Subscription } from './Subscriptions.js';
 import { Price } from './Prices.js';
+import { TaxRate } from './TaxRates.js';
 import * as Billing from './Billing/index.js';
 import { Metadata, Decimal } from '../shared.js';
 export interface InvoiceLineItem {
@@ -44,6 +46,14 @@ export interface InvoiceLineItem {
      * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
      */
     livemode: boolean;
+    /**
+     * The amount of margin calculated per margin for this line item.
+     */
+    margin_amounts?: Array<InvoiceLineItem.MarginAmount> | null;
+    /**
+     * The margins applied to the line item. When set, the `default_margins` on the invoice do not apply to the line item. Use `expand[]=margins` to expand each margin.
+     */
+    margins?: Array<string | Margin> | null;
     /**
      * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
      */
@@ -74,6 +84,10 @@ export interface InvoiceLineItem {
      * The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.
      */
     subtotal: number;
+    /**
+     * The tax calculation identifiers of the line item.
+     */
+    tax_calculation_reference?: InvoiceLineItem.TaxCalculationReference | null;
     /**
      * The tax information of the line item.
      */
@@ -90,11 +104,33 @@ export declare namespace InvoiceLineItem {
          */
         discount: string | Discount | DeletedDiscount;
     }
+    interface MarginAmount {
+        /**
+         * The amount, in cents (or local equivalent), of the reduction in line item amount.
+         */
+        amount: number;
+        /**
+         * The margin that was applied to get this margin amount.
+         */
+        margin: string | Margin;
+    }
     interface Parent {
         /**
          * Details about the invoice item that generated this line item
          */
         invoice_item_details: Parent.InvoiceItemDetails | null;
+        /**
+         * Details about the pricing plan subscription that generated this line item
+         */
+        pricing_plan_subscription_details?: Parent.PricingPlanSubscriptionDetails | null;
+        /**
+         * Details about the rate card subscription that generated this line item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+        /**
+         * Details about the subscription schedule that generated this line item
+         */
+        schedule_details?: Parent.ScheduleDetails | null;
         /**
          * Details about the subscription item that generated this line item
          */
@@ -127,22 +163,39 @@ export declare namespace InvoiceLineItem {
          * The discount that was applied to get this pretax credit amount.
          */
         discount?: string | Discount | DeletedDiscount;
+        /**
+         * The margin that was applied to get this pretax credit amount.
+         */
+        margin?: string | Margin;
         /**
          * Type of the pretax credit amount referenced.
          */
         type: PretaxCreditAmount.Type;
     }
     interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
         price_details?: Pricing.PriceDetails;
+        rate_card_custom_pricing_unit_overage_rate_details?: Pricing.RateCardCustomPricingUnitOverageRateDetails;
+        rate_card_rate_details?: Pricing.RateCardRateDetails;
         /**
          * The type of the pricing details.
          */
-        type: 'price_details';
+        type: Pricing.Type;
         /**
          * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
          */
         unit_amount_decimal: Decimal | null;
     }
+    interface TaxCalculationReference {
+        /**
+         * The calculation identifier for tax calculation response.
+         */
+        calculation_id: string | null;
+        /**
+         * The calculation identifier for tax calculation response line item.
+         */
+        calculation_item_id: string | null;
+    }
     interface Tax {
         /**
          * The amount of the tax, in cents (or local equivalent).
@@ -188,6 +241,56 @@ export declare namespace InvoiceLineItem {
              */
             subscription: string | null;
         }
+        interface PricingPlanSubscriptionDetails {
+            /**
+             * The invoice item that generated this line item
+             */
+            invoice_item: string;
+            /**
+             * The pricing plan subscription that manages this charge
+             */
+            pricing_plan_subscription: string;
+            /**
+             * The pricing plan version at the time this charge was generated
+             */
+            pricing_plan_version: string;
+        }
+        interface RateCardSubscriptionDetails {
+            /**
+             * The invoice item that generated this line item
+             */
+            invoice_item: string;
+            /**
+             * The rate card subscription that generated this line item
+             */
+            rate_card_subscription: string;
+            /**
+             * The rate card version at the time this line item was generated
+             */
+            rate_card_version: string;
+        }
+        interface ScheduleDetails {
+            /**
+             * The invoice item that generated this line item.
+             */
+            invoice_item: string | null;
+            /**
+             * Whether this is a proration.
+             */
+            proration: boolean;
+            /**
+             * Additional details for proration line items.
+             */
+            proration_details: ScheduleDetails.ProrationDetails | null;
+            /**
+             * The subscription schedule that generated this line item.
+             */
+            schedule: string;
+            /**
+             * The subscription that the schedule belongs to.
+             */
+            subscription: string | null;
+        }
         interface SubscriptionItemDetails {
             /**
              * The invoice item that generated this line item
@@ -210,7 +313,7 @@ export declare namespace InvoiceLineItem {
              */
             subscription_item: string;
         }
-        type Type = 'invoice_item_details' | 'subscription_item_details';
+        type Type = 'invoice_item_details' | 'pricing_plan_subscription_details' | 'rate_card_subscription_details' | 'schedule_details' | 'subscription_item_details';
         namespace InvoiceItemDetails {
             interface ProrationDetails {
                 /**
@@ -231,6 +334,26 @@ export declare namespace InvoiceLineItem {
                 }
             }
         }
+        namespace ScheduleDetails {
+            interface ProrationDetails {
+                /**
+                 * For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+                 */
+                credited_items: ProrationDetails.CreditedItems | null;
+            }
+            namespace ProrationDetails {
+                interface CreditedItems {
+                    /**
+                     * Invoice containing the credited invoice line items
+                     */
+                    invoice: string;
+                    /**
+                     * Credited invoice line items
+                     */
+                    invoice_line_items: Array<string>;
+                }
+            }
+        }
         namespace SubscriptionItemDetails {
             interface ProrationDetails {
                 /**
@@ -253,9 +376,23 @@ export declare namespace InvoiceLineItem {
         }
     }
     namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
     }
     namespace Pricing {
+        interface LicenseFeeDetails {
+            /**
+             * The ID of the license fee this item is associated with
+             */
+            license_fee: string;
+            /**
+             * The version of the license fee this item is associated with
+             */
+            license_fee_version: string;
+            /**
+             * The ID of the licensed item this item is associated with
+             */
+            licensed_item: string;
+        }
         interface PriceDetails {
             /**
              * The ID of the price this item is associated with.
@@ -266,6 +403,39 @@ export declare namespace InvoiceLineItem {
              */
             product: string;
         }
+        interface RateCardCustomPricingUnitOverageRateDetails {
+            /**
+             * The ID of the custom pricing unit this item is associated with
+             */
+            custom_pricing_unit: string;
+            /**
+             * The ID of the custom pricing unit overage rate this item is associated with
+             */
+            custom_pricing_unit_overage_rate: string;
+            /**
+             * The ID of the one-time item this custom pricing unit overage rate is associated with
+             */
+            one_time_item: string;
+            /**
+             * The ID of the rate card this item is associated with
+             */
+            rate_card: string;
+        }
+        interface RateCardRateDetails {
+            /**
+             * The ID of billable item this item is associated with
+             */
+            metered_item: string;
+            /**
+             * The ID of the rate card this item is associated with
+             */
+            rate_card: string;
+            /**
+             * The ID of the rate card rate this item is associated with
+             */
+            rate_card_rate: string;
+        }
+        type Type = 'license_fee_details' | 'price_details' | 'rate_card_custom_pricing_unit_overage_rate_details' | 'rate_card_rate_details';
     }
     namespace Tax {
         type TaxBehavior = 'exclusive' | 'inclusive';
@@ -273,7 +443,7 @@ export declare namespace InvoiceLineItem {
             /**
              * ID of the tax rate
              */
-            tax_rate: string;
+            tax_rate: string | TaxRate;
         }
         type TaxabilityReason = 'customer_exempt' | 'not_available' | 'not_collecting' | 'not_subject_to_tax' | 'not_supported' | 'portion_product_exempt' | 'portion_reduced_rated' | 'portion_standard_rated' | 'product_exempt' | 'product_exempt_holiday' | 'proportionally_rated' | 'reduced_rated' | 'reverse_charge' | 'standard_rated' | 'taxable_basis_reduced' | 'zero_rated';
     }

package/esm/resources/InvoiceRenderingTemplates.d.ts

@@ -18,6 +18,14 @@ export declare class InvoiceRenderingTemplateResource extends StripeResource {
      * Unarchive an invoice rendering template so it can be used on new Stripe objects again.
      */
     unarchive(id: string, params?: InvoiceRenderingTemplateUnarchiveParams, options?: RequestOptions): Promise<Response<InvoiceRenderingTemplate>>;
+    serializeBatchArchive(template: string, params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
+    serializeBatchUnarchive(template: string, params?: Record<string, unknown>, options?: {
+        apiVersion?: string;
+        stripeContext?: string;
+    }): string;
 }
 export interface InvoiceRenderingTemplate {
     /**
@@ -79,6 +87,10 @@ export interface InvoiceRenderingTemplateArchiveParams {
      */
     expand?: Array<string>;
 }
+export interface InvoiceRenderingTemplateSerializeBatchArchiveParams {
+}
+export interface InvoiceRenderingTemplateSerializeBatchUnarchiveParams {
+}
 export interface InvoiceRenderingTemplateUnarchiveParams {
     /**
      * Specifies which fields in the response should be expanded.