stripe 20.1.0-beta.1 → 20.1.0

package/types/InvoiceItemsResource.d.ts

@@ -14,12 +14,12 @@ declare module 'stripe' {
       currency?: string;
 
       /**
-       * The ID of the customer who will be billed when this invoice item is billed.
+       * The ID of the customer to bill for this invoice item.
        */
       customer?: string;
 
       /**
-       * The ID of the account who will be billed when this invoice item is billed.
+       * The ID of the account representing the customer to bill for this invoice item.
        */
       customer_account?: string;
 
@@ -49,22 +49,17 @@ 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`.
+       * 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`.
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
       /**
-       * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
+       * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
        */
       period?: InvoiceItemCreateParams.Period;
 
       /**
-       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
+       * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
        */
       price_data?: InvoiceItemCreateParams.PriceData;
 
@@ -84,12 +79,12 @@ declare module 'stripe' {
       subscription?: string;
 
       /**
-       * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+       * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
        */
       tax_behavior?: InvoiceItemCreateParams.TaxBehavior;
 
       /**
-       * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
        */
       tax_code?: Stripe.Emptyable<string>;
 
@@ -116,56 +111,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.
@@ -190,7 +141,7 @@ declare module 'stripe' {
         product: string;
 
         /**
-         * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+         * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          */
         tax_behavior?: PriceData.TaxBehavior;
 
@@ -253,22 +204,17 @@ 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`.
+       * 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`.
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
       /**
-       * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
+       * The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
        */
       period?: InvoiceItemUpdateParams.Period;
 
       /**
-       * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
+       * Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
        */
       price_data?: InvoiceItemUpdateParams.PriceData;
 
@@ -283,12 +229,12 @@ declare module 'stripe' {
       quantity?: number;
 
       /**
-       * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+       * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
        */
       tax_behavior?: InvoiceItemUpdateParams.TaxBehavior;
 
       /**
-       * A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+       * A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
        */
       tax_code?: Stripe.Emptyable<string>;
 
@@ -315,56 +261,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.
@@ -389,7 +291,7 @@ declare module 'stripe' {
         product: string;
 
         /**
-         * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+         * Only required if a [default tax behavior](https://docs.stripe.com/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
          */
         tax_behavior?: PriceData.TaxBehavior;
 
@@ -425,12 +327,12 @@ declare module 'stripe' {
       created?: Stripe.RangeQueryParam | number;
 
       /**
-       * The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
+       * The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
        */
       customer?: string;
 
       /**
-       * The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
+       * The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
        */
       customer_account?: string;
 

package/types/InvoiceLineItems.d.ts

@@ -3,9 +3,9 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * Invoice Line Items represent the individual lines within an [invoice](https://stripe.com/docs/api/invoices) and only exist within the context of an invoice.
+     * Invoice Line Items represent the individual lines within an [invoice](https://docs.stripe.com/api/invoices) and only exist within the context of an invoice.
      *
-     * Each line item is backed by either an [invoice item](https://stripe.com/docs/api/invoiceitems) or a [subscription item](https://stripe.com/docs/api/subscription_items).
+     * Each line item is backed by either an [invoice item](https://docs.stripe.com/api/invoiceitems) or a [subscription item](https://docs.stripe.com/api/subscription_items).
      */
     interface InvoiceLineItem {
       /**
@@ -59,17 +59,7 @@ 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.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.
        */
       metadata: Stripe.Metadata;
 
@@ -98,9 +88,9 @@ declare module 'stripe' {
       subscription: string | Stripe.Subscription | null;
 
       /**
-       * The tax calculation identifiers of the line item.
+       * The subtotal of the line item, in cents (or local equivalent), before any discounts or taxes.
        */
-      tax_calculation_reference?: InvoiceLineItem.TaxCalculationReference | null;
+      subtotal: number;
 
       /**
        * The tax information of the line item.
@@ -121,18 +111,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 +258,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 +265,7 @@ declare module 'stripe' {
       }
 
       namespace PretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
+        type Type = 'credit_balance_transaction' | 'discount';
       }
 
       interface Pricing {
@@ -314,7 +287,7 @@ declare module 'stripe' {
           /**
            * The ID of the price this item is associated with.
            */
-          price: string;
+          price: string | Stripe.Price;
 
           /**
            * The ID of the product this item is associated with.
@@ -377,21 +350,12 @@ declare module 'stripe' {
         type TaxBehavior = 'exclusive' | 'inclusive';
 
         interface TaxRateDetails {
+          /**
+           * ID of the tax rate
+           */
           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

@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * 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.
+     * 1. By expanding the `payments` field on the [Invoice](https://api.stripe.com#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.

package/types/InvoiceRenderingTemplates.d.ts

@@ -28,7 +28,7 @@ declare module 'stripe' {
       livemode: boolean;
 
       /**
-       * 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.
+       * 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.
        */
       metadata: Stripe.Metadata | null;