stripe 18.5.0 → 18.6.0-alpha.1

package/types/InvoiceItems.d.ts

@@ -58,6 +58,11 @@ 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.
        */
@@ -93,6 +98,11 @@ 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.
        */
@@ -133,6 +143,16 @@ declare module 'stripe' {
 
     namespace InvoiceItem {
       interface Parent {
+        /**
+         * Details about the license fee subscription that generated this invoice item
+         */
+        license_fee_subscription_details?: Parent.LicenseFeeSubscriptionDetails | null;
+
+        /**
+         * Details about the rate card subscription that generated this invoice item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+
         /**
          * Details about the subscription that generated this invoice item
          */
@@ -141,10 +161,54 @@ declare module 'stripe' {
         /**
          * The type of parent that generated this invoice item
          */
-        type: 'subscription_details';
+        type: Parent.Type;
       }
 
       namespace Parent {
+        interface LicenseFeeSubscriptionDetails {
+          /**
+           * The license fee subscription that generated this invoice item
+           */
+          license_fee_subscription: string;
+
+          /**
+           * The license fee version that generated this invoice item
+           */
+          license_fee_version: string;
+
+          /**
+           * The pricing plan subscription that manages the license fee subscription
+           */
+          pricing_plan_subscription: string;
+
+          /**
+           * The pricing plan version at the time this invoice item was generated
+           */
+          pricing_plan_version: string;
+        }
+
+        interface RateCardSubscriptionDetails {
+          /**
+           * The pricing plan subscription that manages the rate card subscription
+           */
+          pricing_plan_subscription?: string | null;
+
+          /**
+           * The pricing plan version at the time this invoice item was generated
+           */
+          pricing_plan_version?: string | null;
+
+          /**
+           * 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 SubscriptionDetails {
           /**
            * The subscription that generated this invoice item
@@ -156,6 +220,11 @@ declare module 'stripe' {
            */
           subscription_item?: string;
         }
+
+        type Type =
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'subscription_details';
       }
 
       interface Period {
@@ -171,12 +240,16 @@ declare module 'stripe' {
       }
 
       interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
+
         price_details?: Pricing.PriceDetails;
 
+        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.
@@ -185,6 +258,23 @@ declare module 'stripe' {
       }
 
       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.
@@ -196,6 +286,28 @@ declare module 'stripe' {
            */
           product: 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_rate_details';
       }
     }
   }

package/types/InvoiceItemsResource.d.ts

@@ -3,11 +3,6 @@
 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.
        */
@@ -18,6 +13,16 @@ 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.
        */
@@ -43,6 +48,11 @@ 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`.
        */
@@ -106,12 +116,56 @@ 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.
@@ -198,6 +252,11 @@ 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`.
        */
@@ -256,12 +315,56 @@ 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.
@@ -326,6 +429,11 @@ 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.
        */
@@ -349,7 +457,10 @@ 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,
+        params?: InvoiceItemCreateParams,
+        options?: RequestOptions
+      ): Promise<Stripe.Response<Stripe.InvoiceItem>>;
+      create(
         options?: RequestOptions
       ): Promise<Stripe.Response<Stripe.InvoiceItem>>;
 

package/types/InvoiceLineItems.d.ts

@@ -58,6 +58,16 @@ 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.
        */
@@ -87,6 +97,11 @@ 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.
        */
@@ -106,12 +121,34 @@ 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
          */
         invoice_item_details: Parent.InvoiceItemDetails | null;
 
+        /**
+         * Details about the license fee subscription that generated this line item
+         */
+        license_fee_subscription_details?: Parent.LicenseFeeSubscriptionDetails | null;
+
+        /**
+         * Details about the rate card subscription that generated this line item
+         */
+        rate_card_subscription_details?: Parent.RateCardSubscriptionDetails | null;
+
         /**
          * Details about the subscription item that generated this line item
          */
@@ -169,6 +206,60 @@ declare module 'stripe' {
           }
         }
 
+        interface LicenseFeeSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The license fee subscription that generated this line item
+           */
+          license_fee_subscription: string;
+
+          /**
+           * The license fee version at the time this line item was generated
+           */
+          license_fee_version: string;
+
+          /**
+           * The pricing plan subscription that manages the license fee subscription
+           */
+          pricing_plan_subscription: string;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version: string;
+        }
+
+        interface RateCardSubscriptionDetails {
+          /**
+           * The invoice item that generated this line item
+           */
+          invoice_item: string;
+
+          /**
+           * The pricing plan subscription that manages the rate card subscription
+           */
+          pricing_plan_subscription?: string | null;
+
+          /**
+           * The pricing plan version at the time this line item was generated
+           */
+          pricing_plan_version?: string | null;
+
+          /**
+           * 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 SubscriptionItemDetails {
           /**
            * The invoice item that generated this line item
@@ -219,7 +310,11 @@ declare module 'stripe' {
           }
         }
 
-        type Type = 'invoice_item_details' | 'subscription_item_details';
+        type Type =
+          | 'invoice_item_details'
+          | 'license_fee_subscription_details'
+          | 'rate_card_subscription_details'
+          | 'subscription_item_details';
       }
 
       interface Period {
@@ -253,6 +348,11 @@ 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.
          */
@@ -260,16 +360,20 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount';
+        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
       }
 
       interface Pricing {
+        license_fee_details?: Pricing.LicenseFeeDetails;
+
         price_details?: Pricing.PriceDetails;
 
+        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.
@@ -278,6 +382,23 @@ declare module 'stripe' {
       }
 
       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.
@@ -289,6 +410,28 @@ declare module 'stripe' {
            */
           product: 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_rate_details';
       }
 
       interface Tax {
@@ -348,6 +491,18 @@ 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

@@ -80,6 +80,11 @@ 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

@@ -38,10 +38,19 @@ declare module 'stripe' {
          */
         payment_intent?: string;
 
+        /**
+         * Only return invoice payments associated by this payment record ID.
+         */
+        payment_record?: string;
+
         /**
          * Only return invoice payments associated by this payment type.
          */
-        type: 'payment_intent';
+        type: Payment.Type;
+      }
+
+      namespace Payment {
+        type Type = 'payment_intent' | 'payment_record';
       }
 
       type Status = 'canceled' | 'open' | 'paid';