stripe 18.2.0-beta.1 → 18.2.0

package/types/Identity/VerificationSessionsResource.d.ts

@@ -34,11 +34,6 @@ declare module 'stripe' {
          */
         related_customer?: string;
 
-        /**
-         * Token referencing a Customer Account resource.
-         */
-        related_customer_account?: string;
-
         /**
          * The URL that the user will be redirected to upon completing the verification flow.
          */
@@ -209,8 +204,6 @@ declare module 'stripe' {
 
         related_customer?: string;
 
-        related_customer_account?: string;
-
         /**
          * Only return VerificationSessions with this status. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work).
          */
@@ -243,7 +236,7 @@ declare module 'stripe' {
          *
          * If your API key is in test mode, verification checks won't actually process, though everything else will occur as if in live mode.
          *
-         * Related guide: [Verify your users' identity documents](https://stripe.com/docs/identity/verify-identity-documents)
+         * Related guide: [Verify your users' identity documents](https://docs.stripe.com/docs/identity/verify-identity-documents)
          */
         create(
           params?: VerificationSessionCreateParams,
@@ -293,9 +286,9 @@ declare module 'stripe' {
         ): ApiListPromise<Stripe.Identity.VerificationSession>;
 
         /**
-         * A VerificationSession object can be canceled when it is in requires_input [status](https://stripe.com/docs/identity/how-sessions-work).
+         * A VerificationSession object can be canceled when it is in requires_input [status](https://docs.stripe.com/docs/identity/how-sessions-work).
          *
-         * Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://stripe.com/docs/identity/verification-sessions#cancel).
+         * Once canceled, future submission attempts are disabled. This cannot be undone. [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#cancel).
          */
         cancel(
           id: string,
@@ -313,7 +306,7 @@ declare module 'stripe' {
          * request logs, etc.
          *
          * A VerificationSession object can be redacted when it is in requires_input or verified
-         * [status](https://stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
+         * [status](https://docs.stripe.com/docs/identity/how-sessions-work). Redacting a VerificationSession in requires_action
          * state will automatically cancel it.
          *
          * The redaction process may take up to four days. When the redaction process is in progress, the
@@ -326,7 +319,7 @@ declare module 'stripe' {
          * placeholder. The metadata field will also be erased. Redacted objects cannot be updated or
          * used for any purpose.
          *
-         * [Learn more](https://stripe.com/docs/identity/verification-sessions#redact).
+         * [Learn more](https://docs.stripe.com/docs/identity/verification-sessions#redact).
          */
         redact(
           id: string,

package/types/InvoiceItems.d.ts

@@ -61,11 +61,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
-      /**
-       * The ID of the account who will be billed when this invoice item is billed.
-       */
-      customer_account?: string | null;
-
       /**
        * Time at which the object was created. Measured in seconds since the Unix epoch.
        */
@@ -101,18 +96,13 @@ declare module 'stripe' {
        */
       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 | Stripe.Margin> | null;
-
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
       metadata: Stripe.Metadata | null;
 
       /**
-       * The parent that generated this invoice
+       * The parent that generated this invoice item.
        */
       parent: InvoiceItem.Parent | null;
 

package/types/InvoiceItemsResource.d.ts

@@ -3,6 +3,11 @@
 declare module 'stripe' {
   namespace Stripe {
     interface InvoiceItemCreateParams {
+      /**
+       * The ID of the customer who will be billed when this invoice item is billed.
+       */
+      customer: string;
+
       /**
        * The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. Passing in a negative `amount` will reduce the `amount_due` on the invoice.
        */
@@ -13,16 +18,6 @@ declare module 'stripe' {
        */
       currency?: string;
 
-      /**
-       * The ID of the customer who will be billed when this invoice item is billed.
-       */
-      customer?: string;
-
-      /**
-       * The ID of the account who will be billed when this invoice item is billed.
-       */
-      customer_account?: string;
-
       /**
        * An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
        */
@@ -48,11 +43,6 @@ declare module 'stripe' {
        */
       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://stripe.com/docs/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`.
        */
@@ -116,56 +106,12 @@ declare module 'stripe' {
          */
         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.
          */
         promotion_code?: string;
       }
 
-      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;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.
@@ -252,11 +198,6 @@ declare module 'stripe' {
        */
       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?: Stripe.Emptyable<Array<string>>;
-
       /**
        * Set of [key-value pairs](https://stripe.com/docs/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`.
        */
@@ -315,56 +256,12 @@ declare module 'stripe' {
          */
         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.
          */
         promotion_code?: string;
       }
 
-      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;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface Period {
         /**
          * The end of the period, which must be greater than or equal to the start. This value is inclusive.
@@ -429,11 +326,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -457,10 +349,7 @@ declare module 'stripe' {
        * 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<Stripe.Response<Stripe.InvoiceItem>>;
-      create(
+        params: InvoiceItemCreateParams,
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.InvoiceItem>>;
 

package/types/InvoiceLineItems.d.ts

@@ -58,23 +58,13 @@ declare module 'stripe' {
        */
       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 | Stripe.Margin> | null;
-
       /**
        * Set of [key-value pairs](https://stripe.com/docs/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.
        */
       metadata: Stripe.Metadata;
 
       /**
-       * The parent that generated this invoice
+       * The parent that generated this line item.
        */
       parent: InvoiceLineItem.Parent | null;
 
@@ -97,11 +87,6 @@ declare module 'stripe' {
 
       subscription: string | Stripe.Subscription | null;
 
-      /**
-       * The tax calculation identifiers of the line item.
-       */
-      tax_calculation_reference?: InvoiceLineItem.TaxCalculationReference | null;
-
       /**
        * The tax information of the line item.
        */
@@ -121,18 +106,6 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.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 | Stripe.Margin;
-      }
-
       interface Parent {
         /**
          * Details about the invoice item that generated this line item
@@ -280,11 +253,6 @@ declare module 'stripe' {
          */
         discount?: string | Stripe.Discount | Stripe.DeletedDiscount;
 
-        /**
-         * The margin that was applied to get this pretax credit amount.
-         */
-        margin?: string | Stripe.Margin;
-
         /**
          * Type of the pretax credit amount referenced.
          */
@@ -292,7 +260,7 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
+        type Type = 'credit_balance_transaction' | 'discount';
       }
 
       interface Pricing {
@@ -380,18 +348,6 @@ declare module 'stripe' {
           tax_rate: string;
         }
       }
-
-      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;
-      }
     }
   }
 }

package/types/InvoicePayments.d.ts

@@ -3,7 +3,14 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The invoice payment object
+     * Invoice Payments represent payments made against invoices. Invoice Payments can
+     * be accessed in two ways:
+     * 1. By expanding the `payments` field on the [Invoice](https://stripe.com/docs/api#invoice) resource.
+     * 2. By using the Invoice Payment retrieve and list endpoints.
+     *
+     * Invoice Payments include the mapping between payment objects, such as Payment Intent, and Invoices.
+     * This resource and its endpoints allows you to easily track if a payment is associated with a specific invoice and
+     * monitor the allocation details of the payments.
      */
     interface InvoicePayment {
       /**
@@ -64,7 +71,7 @@ declare module 'stripe' {
     namespace InvoicePayment {
       interface Payment {
         /**
-         * ID of the successful charge for this payment when `type` is `charge`.
+         * ID of the successful charge for this payment when `type` is `charge`.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.
          */
         charge?: string | Stripe.Charge;
 
@@ -73,11 +80,6 @@ declare module 'stripe' {
          */
         payment_intent?: string | Stripe.PaymentIntent;
 
-        /**
-         * ID of the PaymentRecord associated with this payment when `type` is `payment_record`.
-         */
-        payment_record?: string | Stripe.PaymentRecord;
-
         /**
          * Type of payment object associated with this invoice payment.
          */

package/types/InvoicePaymentsResource.d.ts

@@ -0,0 +1,74 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    interface InvoicePaymentRetrieveParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+    }
+
+    interface InvoicePaymentListParams extends PaginationParams {
+      /**
+       * Specifies which fields in the response should be expanded.
+       */
+      expand?: Array<string>;
+
+      /**
+       * The identifier of the invoice whose payments to return.
+       */
+      invoice?: string;
+
+      /**
+       * The payment details of the invoice payments to return.
+       */
+      payment?: InvoicePaymentListParams.Payment;
+
+      /**
+       * The status of the invoice payments to return.
+       */
+      status?: InvoicePaymentListParams.Status;
+    }
+
+    namespace InvoicePaymentListParams {
+      interface Payment {
+        /**
+         * Only return invoice payments associated by this payment intent ID.
+         */
+        payment_intent?: string;
+
+        /**
+         * Only return invoice payments associated by this payment type.
+         */
+        type: 'payment_intent';
+      }
+
+      type Status = 'canceled' | 'open' | 'paid';
+    }
+
+    class InvoicePaymentsResource {
+      /**
+       * Retrieves the invoice payment with the given ID.
+       */
+      retrieve(
+        id: string,
+        params?: InvoicePaymentRetrieveParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+      retrieve(
+        id: string,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoicePayment>>;
+
+      /**
+       * When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+       */
+      list(
+        params?: InvoicePaymentListParams,
+        options?: RequestOptions
+      ): ApiListPromise<Stripe.InvoicePayment>;
+      list(options?: RequestOptions): ApiListPromise<Stripe.InvoicePayment>;
+    }
+  }
+}