stripe 17.8.0-beta.1 → 18.0.0

package/types/InvoiceItemsResource.d.ts

@@ -43,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`.
        */
@@ -59,14 +54,14 @@ declare module 'stripe' {
       period?: InvoiceItemCreateParams.Period;
 
       /**
-       * The ID of the price object. One of `price` or `price_data` is required.
+       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
        */
-      price?: string;
+      price_data?: InvoiceItemCreateParams.PriceData;
 
       /**
-       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+       * The pricing information for the invoice item.
        */
-      price_data?: InvoiceItemCreateParams.PriceData;
+      pricing?: InvoiceItemCreateParams.Pricing;
 
       /**
        * Non-negative integer. The quantity of units for the invoice item.
@@ -94,12 +89,7 @@ declare module 'stripe' {
       tax_rates?: Array<string>;
 
       /**
-       * The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount` will reduce the `amount_due` on the invoice.
-       */
-      unit_amount?: number;
-
-      /**
-       * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+       * The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
        */
       unit_amount_decimal?: string;
     }
@@ -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.
@@ -185,7 +131,7 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * The ID of the product that this price will belong to.
+         * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          */
         product: string;
 
@@ -209,6 +155,13 @@ declare module 'stripe' {
         type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
       }
 
+      interface Pricing {
+        /**
+         * The ID of the price object.
+         */
+        price?: string;
+      }
+
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 
@@ -245,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`.
        */
@@ -261,14 +209,14 @@ declare module 'stripe' {
       period?: InvoiceItemUpdateParams.Period;
 
       /**
-       * The ID of the price object. One of `price` or `price_data` is required.
+       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
        */
-      price?: string;
+      price_data?: InvoiceItemUpdateParams.PriceData;
 
       /**
-       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+       * The pricing information for the invoice item.
        */
-      price_data?: InvoiceItemUpdateParams.PriceData;
+      pricing?: InvoiceItemUpdateParams.Pricing;
 
       /**
        * Non-negative integer. The quantity of units for the invoice item.
@@ -291,12 +239,7 @@ declare module 'stripe' {
       tax_rates?: Stripe.Emptyable<Array<string>>;
 
       /**
-       * The integer unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.
-       */
-      unit_amount?: number;
-
-      /**
-       * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+       * The decimal unit amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. This `unit_amount_decimal` will be multiplied by the quantity to get the full amount. Passing in a negative `unit_amount_decimal` will reduce the `amount_due` on the invoice. Accepts at most 12 decimal places.
        */
       unit_amount_decimal?: string;
     }
@@ -313,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.
@@ -382,7 +281,7 @@ declare module 'stripe' {
         currency: string;
 
         /**
-         * The ID of the product that this price will belong to.
+         * The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
          */
         product: string;
 
@@ -406,6 +305,13 @@ declare module 'stripe' {
         type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
       }
 
+      interface Pricing {
+        /**
+         * The ID of the price object.
+         */
+        price?: string;
+      }
+
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 

package/types/InvoiceLineItems.d.ts

@@ -23,11 +23,6 @@ declare module 'stripe' {
        */
       amount: number;
 
-      /**
-       * The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.
-       */
-      amount_excluding_tax: number | null;
-
       /**
        * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
        */
@@ -58,37 +53,22 @@ declare module 'stripe' {
        */
       invoice: string | null;
 
-      /**
-       * The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any.
-       */
-      invoice_item?: string | Stripe.InvoiceItem;
-
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */
       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;
 
-      period: InvoiceLineItem.Period;
-
       /**
-       * The plan of the subscription, if the line item is a subscription or a proration.
+       * The parent that generated this invoice
        */
-      plan: Stripe.Plan | null;
+      parent: InvoiceLineItem.Parent | null;
+
+      period: InvoiceLineItem.Period;
 
       /**
        * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.
@@ -96,54 +76,21 @@ declare module 'stripe' {
       pretax_credit_amounts: Array<InvoiceLineItem.PretaxCreditAmount> | null;
 
       /**
-       * The price of the line item.
+       * The pricing information of the line item.
        */
-      price: Stripe.Price | null;
-
-      /**
-       * Whether this is a proration.
-       */
-      proration: boolean;
-
-      /**
-       * Additional details for proration line items
-       */
-      proration_details: InvoiceLineItem.ProrationDetails | null;
+      pricing: InvoiceLineItem.Pricing | null;
 
       /**
        * The quantity of the subscription, if the line item is a subscription or a proration.
        */
       quantity: number | null;
 
-      /**
-       * The subscription that the invoice item pertains to, if any.
-       */
       subscription: string | Stripe.Subscription | null;
 
       /**
-       * The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription.
-       */
-      subscription_item?: string | Stripe.SubscriptionItem;
-
-      /**
-       * The amount of tax calculated per tax rate for this line item
-       */
-      tax_amounts: Array<InvoiceLineItem.TaxAmount>;
-
-      /**
-       * The tax rates which apply to the line item.
-       */
-      tax_rates: Array<Stripe.TaxRate>;
-
-      /**
-       * A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.
-       */
-      type: InvoiceLineItem.Type;
-
-      /**
-       * The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.
+       * The tax information of the line item.
        */
-      unit_amount_excluding_tax: string | null;
+      taxes: Array<InvoiceLineItem.Tax> | null;
     }
 
     namespace InvoiceLineItem {
@@ -159,16 +106,120 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
-      interface MarginAmount {
+      interface Parent {
         /**
-         * The amount, in cents (or local equivalent), of the reduction in line item amount.
+         * Details about the invoice item that generated this line item
          */
-        amount: number;
+        invoice_item_details: Parent.InvoiceItemDetails | null;
+
+        /**
+         * Details about the subscription item that generated this line item
+         */
+        subscription_item_details: Parent.SubscriptionItemDetails | null;
 
         /**
-         * The margin that was applied to get this margin amount.
+         * The type of parent that generated this line item
          */
-        margin: string | Stripe.Margin;
+        type: Parent.Type;
+      }
+
+      namespace Parent {
+        interface InvoiceItemDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * Whether this is a proration
+           */
+          proration: boolean;
+
+          /**
+           * Additional details for proration line items
+           */
+          proration_details: InvoiceItemDetails.ProrationDetails | null;
+
+          /**
+           * The subscription that the invoice item belongs to
+           */
+          subscription: string | null;
+        }
+
+        namespace InvoiceItemDetails {
+          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>;
+            }
+          }
+        }
+
+        interface SubscriptionItemDetails {
+          /**
+           * 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: SubscriptionItemDetails.ProrationDetails | null;
+
+          /**
+           * The subscription that the subscription item belongs to
+           */
+          subscription: string;
+
+          /**
+           * The subscription item that generated this line item
+           */
+          subscription_item: string;
+        }
+
+        namespace SubscriptionItemDetails {
+          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>;
+            }
+          }
+        }
+
+        type Type = 'invoice_item_details' | 'subscription_item_details';
       }
 
       interface Period {
@@ -202,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.
          */
@@ -214,60 +260,73 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
+        type Type = 'credit_balance_transaction' | 'discount';
       }
 
-      interface ProrationDetails {
+      interface Pricing {
+        price_details?: Pricing.PriceDetails;
+
+        /**
+         * The type of the pricing details.
+         */
+        type: 'price_details';
+
         /**
-         * For a credit proration `line_item`, the original debit line_items to which the credit proration applies.
+         * The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places.
          */
-        credited_items: ProrationDetails.CreditedItems | null;
+        unit_amount_decimal: string | null;
       }
 
-      namespace ProrationDetails {
-        interface CreditedItems {
+      namespace Pricing {
+        interface PriceDetails {
           /**
-           * Invoice containing the credited invoice line items
+           * The ID of the price this item is associated with.
            */
-          invoice: string;
+          price: string;
 
           /**
-           * Credited invoice line items
+           * The ID of the product this item is associated with.
            */
-          invoice_line_items: Array<string>;
+          product: string;
         }
       }
 
-      interface TaxAmount {
+      interface Tax {
         /**
-         * The amount, in cents (or local equivalent), of the tax.
+         * The amount of the tax, in cents (or local equivalent).
          */
         amount: number;
 
         /**
-         * Whether this tax amount is inclusive or exclusive.
+         * Whether this tax is inclusive or exclusive.
          */
-        inclusive: boolean;
+        tax_behavior: Tax.TaxBehavior;
 
         /**
-         * The tax rate that was applied to get this tax amount.
+         * Additional details about the tax rate. Only present when `type` is `tax_rate_details`.
          */
-        tax_rate: string | Stripe.TaxRate;
+        tax_rate_details: Tax.TaxRateDetails | null;
 
         /**
          * The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.
          */
-        taxability_reason: TaxAmount.TaxabilityReason | null;
+        taxability_reason: Tax.TaxabilityReason;
 
         /**
          * The amount on which tax is calculated, in cents (or local equivalent).
          */
         taxable_amount: number | null;
+
+        /**
+         * The type of tax information.
+         */
+        type: 'tax_rate_details';
       }
 
-      namespace TaxAmount {
+      namespace Tax {
         type TaxabilityReason =
           | 'customer_exempt'
+          | 'not_available'
           | 'not_collecting'
           | 'not_subject_to_tax'
           | 'not_supported'
@@ -282,9 +341,13 @@ declare module 'stripe' {
           | 'standard_rated'
           | 'taxable_basis_reduced'
           | 'zero_rated';
-      }
 
-      type Type = 'invoiceitem' | 'subscription';
+        type TaxBehavior = 'exclusive' | 'inclusive';
+
+        interface TaxRateDetails {
+          tax_rate: string;
+        }
+      }
     }
   }
 }

package/types/InvoicePayments.d.ts

@@ -16,11 +16,6 @@ declare module 'stripe' {
        */
       object: 'invoice_payment';
 
-      /**
-       * Excess payment that was received for this invoice and credited to the customer's `invoice_credit_balance`. This field is null until the payment is `paid`. Overpayment can happen when you attach more than one PaymentIntent to the invoice, and each of them succeeds. To avoid overpayment, cancel any PaymentIntents that you do not need before attaching more.
-       */
-      amount_overpaid: number | null;
-
       /**
        * Amount that was actually paid for this invoice, in cents (or local equivalent). This field is null until the payment is `paid`. This amount can be less than the `amount_requested` if the PaymentIntent's `amount_received` is not sufficient to pay all of the invoices that it is attached to.
        */
@@ -49,7 +44,7 @@ declare module 'stripe' {
       /**
        * Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice's `amount_remaining`. The PaymentIntent associated with the default payment can't be edited or canceled directly.
        */
-      is_default: boolean | null;
+      is_default: boolean;
 
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -78,11 +73,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.
          */
@@ -90,11 +80,7 @@ declare module 'stripe' {
       }
 
       namespace Payment {
-        type Type =
-          | 'charge'
-          | 'out_of_band_payment'
-          | 'payment_intent'
-          | 'payment_record';
+        type Type = 'charge' | 'payment_intent';
       }
 
       interface StatusTransitions {