stripe 22.4.0 → 22.5.0-alpha.2

package/cjs/resources/Identity/BlocklistEntries.js

@@ -0,0 +1,54 @@
+"use strict";
+// File generated from our OpenAPI spec
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BlocklistEntryResource = void 0;
+const StripeResource_js_1 = require("../../StripeResource.js");
+class BlocklistEntryResource extends StripeResource_js_1.StripeResource {
+    /**
+     * Returns a list of BlocklistEntry objects associated with your account.
+     *
+     * The blocklist entries are returned sorted by creation date, with the most recently created
+     * entries appearing first.
+     *
+     * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+     */
+    list(params, options) {
+        return this._makeRequest('GET', '/v1/identity/blocklist_entries', params, options, {
+            methodType: 'list',
+        });
+    }
+    /**
+     * Creates a BlocklistEntry object from a verification report.
+     *
+     * A blocklist entry prevents future identity verifications that match the same identity information.
+     * You can create blocklist entries from verification reports that contain document extracted data
+     * or a selfie.
+     *
+     * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#add-a-blocklist-entry)
+     */
+    create(params, options) {
+        return this._makeRequest('POST', '/v1/identity/blocklist_entries', params, options);
+    }
+    /**
+     * Retrieves a BlocklistEntry object by its identifier.
+     *
+     * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#block-list)
+     */
+    retrieve(id, params, options) {
+        return this._makeRequest('GET', `/v1/identity/blocklist_entries/${encodeURIComponent(id)}`, params, options);
+    }
+    /**
+     * Disables a BlocklistEntry object.
+     *
+     * After a BlocklistEntry is disabled, it will no longer block future verifications that match
+     * the same information. This action is irreversible. To re-enable it, a new BlocklistEntry
+     * must be created using the same verification report.
+     *
+     * Related guide: [Identity Verification Blocklist](https://docs.stripe.com/docs/identity/review-tools#disable-a-blocklist-entry)
+     */
+    disable(id, params, options) {
+        return this._makeRequest('POST', `/v1/identity/blocklist_entries/${encodeURIComponent(id)}/disable`, params, options);
+    }
+}
+exports.BlocklistEntryResource = BlocklistEntryResource;
+//# sourceMappingURL=BlocklistEntries.js.map

package/cjs/resources/Identity/BlocklistEntries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BlocklistEntries.js","sourceRoot":"","sources":["../../../src/resources/Identity/BlocklistEntries.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAMvD,MAAa,sBAAuB,SAAQ,kCAAc;IACxD;;;;;;;OAOG;IACH,IAAI,CACF,MAA0C,EAC1C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,gCAAgC,EAChC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;;;;;;;OAQG;IACH,MAAM,CACJ,MAA2C,EAC3C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,gCAAgC,EAChC,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;OAIG;IACH,QAAQ,CACN,EAAU,EACV,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,kCAAkC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;;;;;;;OAQG;IACH,OAAO,CACL,EAAU,EACV,MAA6C,EAC7C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,kCAAkC,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAClE,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjFD,wDAiFC"}

package/cjs/resources/Identity/VerificationReports.d.ts

@@ -1,4 +1,5 @@
 import { StripeResource } from '../../StripeResource.js';
+import { BlocklistEntry } from './BlocklistEntries.js';
 import { PaginationParams, RangeQueryParam, OtherString, Address } from '../../shared.js';
 import { RequestOptions, ApiListPromise, Response } from '../../lib.js';
 export declare class VerificationReportResource extends StripeResource {
@@ -72,6 +73,10 @@ export declare namespace VerificationReport {
          * Address as it appears in the document.
          */
         address: Address | null;
+        /**
+         * If document was not verified due to extracted data being on the blocklist, this is the token of the BlocklistEntry that blocked it
+         */
+        blocked_by_entry?: string | BlocklistEntry | null;
         /**
          * Date of birth as it appears in the document.
          */
@@ -130,6 +135,10 @@ export declare namespace VerificationReport {
         unparsed_sex?: string | null;
     }
     interface Email {
+        /**
+         * Additional email verification details
+         */
+        details?: Email.Details;
         /**
          * Email to be verified.
          */
@@ -192,6 +201,10 @@ export declare namespace VerificationReport {
         status: Phone.Status;
     }
     interface Selfie {
+        /**
+         * If selfie was not verified due to being on the blocklist, this is the token of the BlocklistEntry that blocked it
+         */
+        blocked_by_entry?: string | BlocklistEntry | null;
         /**
          * ID of the [File](https://docs.stripe.com/api/files) holding the image of the identity document used in this check.
          */
@@ -209,7 +222,7 @@ export declare namespace VerificationReport {
          */
         status: Selfie.Status;
     }
-    type Type = 'document' | 'id_number' | 'verification_flow' | OtherString;
+    type Type = 'document' | 'email' | 'id_number' | 'verification_flow' | OtherString;
     namespace Document {
         interface Dob {
             /**
@@ -271,6 +284,20 @@ export declare namespace VerificationReport {
         }
     }
     namespace Email {
+        interface Details {
+            /**
+             * Number of days from the time when the email domain was first observed to the time of verification.
+             */
+            days_since_domain_creation?: number;
+            /**
+             * Number of days from the time when the email address was first observed to the time of verification.
+             */
+            days_since_ownership_started?: number;
+            /**
+             * Two-letter ISO 3166-1 alpha-2 country code of the email domain's country.
+             */
+            domain_country?: string;
+        }
         interface Error {
             /**
              * A short machine-readable string giving the reason for the verification failure.
@@ -385,6 +412,10 @@ export declare namespace Identity {
 }
 export declare namespace Identity {
     interface VerificationReportListParams extends PaginationParams {
+        /**
+         * Only return VerificationReports that were blocked by this BlocklistEntry id.
+         */
+        blocked_by_entry?: string;
         /**
          * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
          */
@@ -407,6 +438,6 @@ export declare namespace Identity {
         verification_session?: string;
     }
     namespace VerificationReportListParams {
-        type Type = 'document' | 'id_number' | OtherString;
+        type Type = 'document' | 'email' | 'id_number' | OtherString;
     }
 }

package/cjs/resources/Identity/VerificationReports.js.map

@@ -1 +1 @@
-{"version":3,"file":"VerificationReports.js","sourceRoot":"","sources":["../../../src/resources/Identity/VerificationReports.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AASvD,MAAa,0BAA2B,SAAQ,kCAAc;IAC5D;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,gEAiCC"}
+{"version":3,"file":"VerificationReports.js","sourceRoot":"","sources":["../../../src/resources/Identity/VerificationReports.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,+DAAuD;AAUvD,MAAa,0BAA2B,SAAQ,kCAAc;IAC5D;;OAEG;IACH,IAAI,CACF,MAA8C,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,mCAAmC,EACnC,MAAM,EACN,OAAO,EACP;YACE,UAAU,EAAE,MAAM;SACnB,CACK,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkD,EAClD,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,qCAAqC,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC7D,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;CACF;AAjCD,gEAiCC"}

package/cjs/resources/Identity/VerificationSessions.d.ts

@@ -184,7 +184,7 @@ export declare namespace VerificationSession {
         person: string;
     }
     type Status = 'canceled' | 'processing' | 'requires_input' | 'verified' | OtherString;
-    type Type = 'document' | 'id_number' | 'verification_flow' | OtherString;
+    type Type = 'document' | 'email' | 'id_number' | 'verification_flow' | OtherString;
     interface VerifiedOutputs {
         /**
          * The user's verified address.
@@ -313,6 +313,10 @@ export declare namespace Identity {
          * A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems.
          */
         client_reference_id?: string;
+        /**
+         * Confirm and submit the provided details for verification.
+         */
+        confirm?: boolean;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -381,7 +385,7 @@ export declare namespace Identity {
              */
             person: string;
         }
-        type Type = 'document' | 'id_number' | OtherString;
+        type Type = 'document' | 'email' | 'id_number' | OtherString;
         namespace Options {
             interface Document {
                 /**
@@ -417,6 +421,10 @@ export declare namespace Identity {
 }
 export declare namespace Identity {
     interface VerificationSessionUpdateParams {
+        /**
+         * Confirm and submit the provided details for verification.
+         */
+        confirm?: boolean;
         /**
          * Specifies which fields in the response should be expanded.
          */
@@ -455,7 +463,7 @@ export declare namespace Identity {
              */
             phone?: string;
         }
-        type Type = 'document' | 'id_number' | OtherString;
+        type Type = 'document' | 'email' | 'id_number' | OtherString;
         namespace Options {
             interface Document {
                 /**

package/cjs/resources/Identity/index.d.ts

@@ -1,23 +1,31 @@
 import { Stripe } from '../../stripe.core.js';
-import { Identity as IdentityNamespace0, VerificationReport, VerificationReportResource } from './VerificationReports.js';
-import { Identity as IdentityNamespace1, VerificationSession, VerificationSessionResource } from './VerificationSessions.js';
+import { Identity as IdentityNamespace0, BlocklistEntry, BlocklistEntryResource } from './BlocklistEntries.js';
+import { Identity as IdentityNamespace1, VerificationReport, VerificationReportResource } from './VerificationReports.js';
+import { Identity as IdentityNamespace2, VerificationSession, VerificationSessionResource } from './VerificationSessions.js';
+export { BlocklistEntry } from './BlocklistEntries.js';
 export { VerificationReport } from './VerificationReports.js';
 export { VerificationSession } from './VerificationSessions.js';
 export declare class Identity {
     private readonly stripe;
+    blocklistEntries: BlocklistEntryResource;
     verificationReports: VerificationReportResource;
     verificationSessions: VerificationSessionResource;
     constructor(stripe: Stripe);
 }
 export declare namespace Identity {
-    export import VerificationReportListParams = IdentityNamespace0.VerificationReportListParams;
-    export import VerificationReportRetrieveParams = IdentityNamespace0.VerificationReportRetrieveParams;
+    export import BlocklistEntryListParams = IdentityNamespace0.BlocklistEntryListParams;
+    export import BlocklistEntryCreateParams = IdentityNamespace0.BlocklistEntryCreateParams;
+    export import BlocklistEntryRetrieveParams = IdentityNamespace0.BlocklistEntryRetrieveParams;
+    export import BlocklistEntryDisableParams = IdentityNamespace0.BlocklistEntryDisableParams;
+    export { BlocklistEntry, BlocklistEntryResource };
+    export import VerificationReportListParams = IdentityNamespace1.VerificationReportListParams;
+    export import VerificationReportRetrieveParams = IdentityNamespace1.VerificationReportRetrieveParams;
     export { VerificationReport, VerificationReportResource };
-    export import VerificationSessionListParams = IdentityNamespace1.VerificationSessionListParams;
-    export import VerificationSessionCreateParams = IdentityNamespace1.VerificationSessionCreateParams;
-    export import VerificationSessionRetrieveParams = IdentityNamespace1.VerificationSessionRetrieveParams;
-    export import VerificationSessionUpdateParams = IdentityNamespace1.VerificationSessionUpdateParams;
-    export import VerificationSessionCancelParams = IdentityNamespace1.VerificationSessionCancelParams;
-    export import VerificationSessionRedactParams = IdentityNamespace1.VerificationSessionRedactParams;
+    export import VerificationSessionListParams = IdentityNamespace2.VerificationSessionListParams;
+    export import VerificationSessionCreateParams = IdentityNamespace2.VerificationSessionCreateParams;
+    export import VerificationSessionRetrieveParams = IdentityNamespace2.VerificationSessionRetrieveParams;
+    export import VerificationSessionUpdateParams = IdentityNamespace2.VerificationSessionUpdateParams;
+    export import VerificationSessionCancelParams = IdentityNamespace2.VerificationSessionCancelParams;
+    export import VerificationSessionRedactParams = IdentityNamespace2.VerificationSessionRedactParams;
     export { VerificationSession, VerificationSessionResource };
 }

package/cjs/resources/Identity/index.js

@@ -2,11 +2,13 @@
 // File generated from our OpenAPI spec
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Identity = void 0;
+const BlocklistEntries_js_1 = require("./BlocklistEntries.js");
 const VerificationReports_js_1 = require("./VerificationReports.js");
 const VerificationSessions_js_1 = require("./VerificationSessions.js");
 class Identity {
     constructor(stripe) {
         this.stripe = stripe;
+        this.blocklistEntries = new BlocklistEntries_js_1.BlocklistEntryResource(stripe);
         this.verificationReports = new VerificationReports_js_1.VerificationReportResource(stripe);
         this.verificationSessions = new VerificationSessions_js_1.VerificationSessionResource(stripe);
     }

package/cjs/resources/Identity/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/Identity/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,qEAIkC;AAClC,uEAImC;AAKnC,MAAa,QAAQ;IAInB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,mBAAmB,GAAG,IAAI,mDAA0B,CAAC,MAAM,CAAC,CAAC;QAClE,IAAI,CAAC,oBAAoB,GAAG,IAAI,qDAA2B,CAAC,MAAM,CAAC,CAAC;IACtE,CAAC;CACF;AARD,4BAQC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/Identity/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAGvC,+DAI+B;AAC/B,qEAIkC;AAClC,uEAImC;AAMnC,MAAa,QAAQ;IAKnB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,IAAI,CAAC,gBAAgB,GAAG,IAAI,4CAAsB,CAAC,MAAM,CAAC,CAAC;QAC3D,IAAI,CAAC,mBAAmB,GAAG,IAAI,mDAA0B,CAAC,MAAM,CAAC,CAAC;QAClE,IAAI,CAAC,oBAAoB,GAAG,IAAI,qDAA2B,CAAC,MAAM,CAAC,CAAC;IACtE,CAAC;CACF;AAVD,4BAUC"}

package/cjs/resources/InvoiceItems.d.ts

@@ -2,10 +2,11 @@ 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';
-import { Emptyable, MetadataParam, Decimal, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
+import { Emptyable, MetadataParam, Decimal, OtherString, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
 import { RequestOptions, Response, ApiListPromise } from '../lib.js';
 export declare class InvoiceItemResource extends StripeResource {
     /**
@@ -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' | 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.
@@ -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' | OtherString;
     }
     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' | OtherString;
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
+            }
+        }
+    }
     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' | OtherString;
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year' | OtherString;
+            }
+        }
+    }
     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/cjs/resources/InvoiceItems.js

@@ -141,6 +141,47 @@ class InvoiceItemResource extends StripeResource_js_1.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);
+    }
 }
 exports.InvoiceItemResource = InvoiceItemResource;
 //# sourceMappingURL=InvoiceItems.js.map

package/cjs/resources/InvoiceItems.js.map

@@ -1 +1 @@
-{"version":3,"file":"InvoiceItems.js","sourceRoot":"","sources":["../../src/resources/InvoiceItems.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAiBpD,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,MAAM,EACN,OAAO,EACP;YACE,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,MAAM,CACJ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,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;AA7KD,kDA6KC"}
+{"version":3,"file":"InvoiceItems.js","sourceRoot":"","sources":["../../src/resources/InvoiceItems.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;AAEvC,4DAAoD;AAmBpD,MAAa,mBAAoB,SAAQ,kCAAc;IACrD;;OAEG;IACH,GAAG,CACD,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,QAAQ,EACR,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,MAAM,EACN,OAAO,CACD,CAAC;IACX,CAAC;IACD;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,MAAkC,EAClC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,KAAK,EACL,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,MAAM,EACN,OAAO,EACP;YACE,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,MAAM,CACJ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,YAAY,CACtB,MAAM,EACN,oBAAoB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC5C,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;AAvOD,kDAuOC"}