stripe 22.4.0 → 22.5.0-alpha.2

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, OtherString } 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' | OtherString;
+        type Type = 'invoice_item_details' | 'pricing_plan_subscription_details' | 'rate_card_subscription_details' | 'schedule_details' | 'subscription_item_details' | OtherString;
         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' | OtherString;
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin' | OtherString;
     }
     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' | OtherString;
     }
     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' | OtherString;
     }

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.

package/esm/resources/InvoiceRenderingTemplates.js

@@ -27,5 +27,33 @@ export class InvoiceRenderingTemplateResource extends StripeResource {
     unarchive(id, params, options) {
         return this._makeRequest('POST', `/v1/invoice_rendering_templates/${encodeURIComponent(id)}/unarchive`, params, options);
     }
+    serializeBatchArchive(template, 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 = { template: template };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
+    serializeBatchUnarchive(template, 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 = { template: template };
+        if (options.stripeContext) {
+            entry.context = options.stripeContext;
+        }
+        return JSON.stringify(entry);
+    }
 }
 //# sourceMappingURL=InvoiceRenderingTemplates.js.map

package/esm/resources/InvoiceRenderingTemplates.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvoiceRenderingTemplates.js","sourceRoot":"","sources":["../../src/resources/InvoiceRenderingTemplates.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAIpD,MAAM,OAAO,gCAAiC,SAAQ,cAAc;IAClE;;OAEG;IACH,IAAI,CACF,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iCAAiC,EACjC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC3D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,OAAO,CACL,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACnE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,SAAS,CACP,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACrE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF"}
+{"version":3,"file":"InvoiceRenderingTemplates.js","sourceRoot":"","sources":["../../src/resources/InvoiceRenderingTemplates.ts"],"names":[],"mappings":"AAAA,uCAAuC;AAEvC,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AAIpD,MAAM,OAAO,gCAAiC,SAAQ,cAAc;IAClE;;OAEG;IACH,IAAI,CACF,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,iCAAiC,EACjC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAA+C,EAC/C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC3D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,OAAO,CACL,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACnE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,SAAS,CACP,EAAU,EACV,MAAgD,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,mCAAmC,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACrE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD,qBAAqB,CACnB,QAAgB,EAChB,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,QAAQ,EAAE,QAAQ,EAAC,CAAC;QACzC,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,uBAAuB,CACrB,QAAgB,EAChB,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,QAAQ,EAAE,QAAQ,EAAC,CAAC;QACzC,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"}