stripe 18.2.0-beta.1 → 18.2.0

package/types/Invoices.d.ts

@@ -47,7 +47,7 @@ declare module 'stripe' {
      * Stripe applies any customer credit on the account before determining the
      * amount due for the invoice (i.e., the amount that will be actually
      * charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
-     * per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
+     * per currency](https://docs.stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
      * invoice is automatically marked paid, and we add the amount due to the
      * customer's credit balance which is applied to the next invoice.
      *
@@ -58,7 +58,7 @@ declare module 'stripe' {
      */
     interface Invoice {
       /**
-       * Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details.
+       * Unique identifier for the object. For preview invoices created using the [create preview](https://stripe.com/docs/api/invoices/create_preview) endpoint, this id will be prefixed with `upcoming_in`.
        */
       id?: string;
 
@@ -109,11 +109,6 @@ declare module 'stripe' {
        */
       amount_shipping: number;
 
-      /**
-       * List of expected payments and corresponding due dates. This value will be null for invoices where collection_method=charge_automatically.
-       */
-      amounts_due?: Array<Invoice.AmountsDue> | null;
-
       /**
        * ID of the Connect Application that created the invoice.
        */
@@ -188,11 +183,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
-      /**
-       * The ID of the account who will be billed.
-       */
-      customer_account?: string | null;
-
       /**
        * The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
        */
@@ -228,11 +218,6 @@ declare module 'stripe' {
        */
       customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
 
-      /**
-       * The margins applied to the invoice. Can be overridden by line item `margins`. Use `expand[]=default_margins` to expand each margin.
-       */
-      default_margins?: Array<string | Stripe.Margin> | null;
-
       /**
        * ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
        */
@@ -353,12 +338,12 @@ declare module 'stripe' {
       payments?: ApiList<Stripe.InvoicePayment>;
 
       /**
-       * End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](https://stripe.com/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
+       * End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
        */
       period_end: number;
 
       /**
-       * Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](https://stripe.com/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
+       * Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](https://docs.stripe.com/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price.
        */
       period_start: number;
 
@@ -441,11 +426,6 @@ declare module 'stripe' {
        */
       total_excluding_tax: number | null;
 
-      /**
-       * The aggregate amounts calculated per margin across all line items.
-       */
-      total_margin_amounts?: Array<Invoice.TotalMarginAmount> | null;
-
       /**
        * Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.
        */
@@ -465,52 +445,6 @@ declare module 'stripe' {
     }
 
     namespace Invoice {
-      interface AmountsDue {
-        /**
-         * Incremental amount due for this payment in cents (or local equivalent).
-         */
-        amount: number;
-
-        /**
-         * The amount in cents (or local equivalent) that was paid for this payment.
-         */
-        amount_paid: number;
-
-        /**
-         * The difference between the payment's amount and amount_paid, in cents (or local equivalent).
-         */
-        amount_remaining: number;
-
-        /**
-         * Number of days from when invoice is finalized until the payment is due.
-         */
-        days_until_due: number | null;
-
-        /**
-         * An arbitrary string attached to the object. Often useful for displaying to users.
-         */
-        description: string | null;
-
-        /**
-         * Date on which a payment plan's payment is due.
-         */
-        due_date: number | null;
-
-        /**
-         * Timestamp when the payment was paid.
-         */
-        paid_at: number | null;
-
-        /**
-         * The status of the payment, one of `open`, `paid`, or `past_due`
-         */
-        status: AmountsDue.Status;
-      }
-
-      namespace AmountsDue {
-        type Status = 'open' | 'paid' | 'past_due';
-      }
-
       interface AutomaticTax {
         /**
          * If Stripe disabled automatic tax, this enum describes why.
@@ -943,16 +877,13 @@ declare module 'stripe' {
           | 'email_invalid'
           | 'expired_card'
           | 'financial_connections_account_inactive'
-          | 'financial_connections_institution_unavailable'
           | 'financial_connections_no_successful_transaction_refresh'
           | 'forwarding_api_inactive'
           | 'forwarding_api_invalid_parameter'
           | 'forwarding_api_retryable_upstream_error'
           | 'forwarding_api_upstream_connection_error'
           | 'forwarding_api_upstream_connection_timeout'
-          | 'gift_card_balance_insufficient'
-          | 'gift_card_code_exists'
-          | 'gift_card_inactive'
+          | 'forwarding_api_upstream_error'
           | 'idempotency_key_in_use'
           | 'incorrect_address'
           | 'incorrect_cvc'
@@ -1042,7 +973,6 @@ declare module 'stripe' {
           | 'return_intent_already_processed'
           | 'routing_number_invalid'
           | 'secret_key_required'
-          | 'sensitive_data_access_expired'
           | 'sepa_unsupported_account'
           | 'setup_attempt_failed'
           | 'setup_intent_authentication_failure'
@@ -1062,7 +992,6 @@ declare module 'stripe' {
           | 'taxes_calculation_failed'
           | 'terminal_location_country_unsupported'
           | 'terminal_reader_busy'
-          | 'terminal_reader_collected_data_invalid'
           | 'terminal_reader_hardware_fault'
           | 'terminal_reader_invalid_location_for_activation'
           | 'terminal_reader_invalid_location_for_payment'
@@ -1075,9 +1004,7 @@ declare module 'stripe' {
           | 'token_in_use'
           | 'transfer_source_balance_parameters_mismatch'
           | 'transfers_not_allowed'
-          | 'url_invalid'
-          | 'v2_account_disconnection_unsupported'
-          | 'v2_account_missing_configuration';
+          | 'url_invalid';
 
         type Type =
           | 'api_error'
@@ -1118,11 +1045,6 @@ declare module 'stripe' {
            */
           metadata: Stripe.Metadata | null;
 
-          /**
-           * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-           */
-          pause_collection?: SubscriptionDetails.PauseCollection | null;
-
           /**
            * The subscription that generated this invoice
            */
@@ -1134,24 +1056,6 @@ declare module 'stripe' {
           subscription_proration_date?: number;
         }
 
-        namespace SubscriptionDetails {
-          interface PauseCollection {
-            /**
-             * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-             */
-            behavior: PauseCollection.Behavior | null;
-
-            /**
-             * The time after which the subscription will resume collecting payments.
-             */
-            resumes_at: number | null;
-          }
-
-          namespace PauseCollection {
-            type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
-          }
-        }
-
         type Type = 'quote_details' | 'subscription_details';
       }
 
@@ -1194,11 +1098,6 @@ declare module 'stripe' {
            */
           customer_balance: PaymentMethodOptions.CustomerBalance | null;
 
-          /**
-           * If paying by `id_bank_transfer`, this sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-           */
-          id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
-
           /**
            * If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
            */
@@ -1304,8 +1203,6 @@ declare module 'stripe' {
             }
           }
 
-          interface IdBankTransfer {}
-
           interface Konbini {}
 
           interface SepaDebit {}
@@ -1340,11 +1237,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * The institution to use to filter for possible accounts to link.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -1357,11 +1249,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1380,13 +1268,11 @@ declare module 'stripe' {
           | 'boleto'
           | 'card'
           | 'cashapp'
-          | 'custom'
           | 'customer_balance'
           | 'eps'
           | 'fpx'
           | 'giropay'
           | 'grabpay'
-          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -1406,7 +1292,6 @@ declare module 'stripe' {
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
-          | 'stripe_balance'
           | 'swish'
           | 'us_bank_account'
           | 'wechat_pay';
@@ -1482,9 +1367,9 @@ declare module 'stripe' {
           amount: number;
 
           /**
-           * Tax rates can be applied to [invoices](https://stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
+           * Tax rates can be applied to [invoices](https://docs.stripe.com/invoicing/taxes/tax-rates), [subscriptions](https://docs.stripe.com/billing/taxes/tax-rates) and [Checkout Sessions](https://docs.stripe.com/payments/checkout/use-manual-tax-rates) to collect tax.
            *
-           * Related guide: [Tax rates](https://stripe.com/billing/taxes/tax-rates)
+           * Related guide: [Tax rates](https://docs.stripe.com/billing/taxes/tax-rates)
            */
           rate: Stripe.TaxRate;
 
@@ -1605,18 +1490,6 @@ declare module 'stripe' {
         discount: string | Stripe.Discount | Stripe.DeletedDiscount;
       }
 
-      interface TotalMarginAmount {
-        /**
-         * 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 TotalPretaxCreditAmount {
         /**
          * The amount, in cents (or local equivalent), of the pretax credit amount.
@@ -1636,11 +1509,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.
          */
@@ -1648,7 +1516,7 @@ declare module 'stripe' {
       }
 
       namespace TotalPretaxCreditAmount {
-        type Type = 'credit_balance_transaction' | 'discount' | 'margin';
+        type Type = 'credit_balance_transaction' | 'discount';
       }
 
       interface TotalTax {