stripe 20.1.0 → 20.2.0-beta.1

package/types/Checkout/SessionsResource.d.ts

@@ -735,12 +735,55 @@ declare module 'stripe' {
            */
           coupon?: string;
 
+          /**
+           * Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
+           */
+          coupon_data?: Discount.CouponData;
+
           /**
            * The ID of a promotion code to apply to this Session.
            */
           promotion_code?: string;
         }
 
+        namespace Discount {
+          interface CouponData {
+            /**
+             * A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+             */
+            amount_off?: number;
+
+            /**
+             * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+             */
+            currency?: string;
+
+            /**
+             * Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+             */
+            duration?: CouponData.Duration;
+
+            /**
+             * 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>;
+
+            /**
+             * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+             */
+            name?: string;
+
+            /**
+             * A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+             */
+            percent_off?: number;
+          }
+
+          namespace CouponData {
+            type Duration = 'forever' | 'once' | 'repeating';
+          }
+        }
+
         type ExcludedPaymentMethodType =
           | 'acss_debit'
           | 'affirm'
@@ -761,6 +804,7 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
+          | 'gopay'
           | 'grabpay'
           | 'ideal'
           | 'kakao_pay'
@@ -778,13 +822,17 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'paypay'
           | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'qris'
+          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
           | 'satispay'
           | 'sepa_debit'
+          | 'shopeepay'
           | 'sofort'
           | 'swish'
           | 'twint'
@@ -1793,6 +1841,11 @@ declare module 'stripe' {
              */
             installments?: Card.Installments;
 
+            /**
+             * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
+             */
+            request_decremental_authorization?: Card.RequestDecrementalAuthorization;
+
             /**
              * Request ability to [capture beyond the standard authorization validity window](https://docs.stripe.com/payments/extended-authorization) for this CheckoutSession.
              */
@@ -1854,6 +1907,8 @@ declare module 'stripe' {
               enabled?: boolean;
             }
 
+            type RequestDecrementalAuthorization = 'if_available' | 'never';
+
             type RequestExtendedAuthorization = 'if_available' | 'never';
 
             type RequestIncrementalAuthorization = 'if_available' | 'never';
@@ -2336,6 +2391,11 @@ declare module 'stripe' {
              */
             reference?: string;
 
+            /**
+             * A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.
+             */
+            reference_id?: string;
+
             /**
              * The risk correlation ID for an on-session payment using a saved PayPal payment method.
              */
@@ -2353,6 +2413,11 @@ declare module 'stripe' {
              * If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
              */
             setup_future_usage?: Stripe.Emptyable<Paypal.SetupFutureUsage>;
+
+            /**
+             * The Stripe connected account IDs of the sellers on the platform for this transaction (optional). Only allowed when [separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers) are used.
+             */
+            subsellers?: Array<string>;
           }
 
           namespace Paypal {
@@ -2481,6 +2546,11 @@ declare module 'stripe' {
              */
             expires_after_seconds?: number;
 
+            /**
+             * Additional fields for mandate creation.
+             */
+            mandate_options?: Pix.MandateOptions;
+
             /**
              * Indicates that you intend to make future payments with this PaymentIntent's payment method.
              *
@@ -2490,11 +2560,68 @@ declare module 'stripe' {
              *
              * When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](https://docs.stripe.com/strong-customer-authentication).
              */
-            setup_future_usage?: 'none';
+            setup_future_usage?: Pix.SetupFutureUsage;
           }
 
           namespace Pix {
             type AmountIncludesIof = 'always' | 'never';
+
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments. Required when `amount_type=fixed`. If not provided for `amount_type=maximum`, defaults to 40000.
+               */
+              amount?: number;
+
+              /**
+               * Determines if the amount includes the IOF tax. Defaults to `never`.
+               */
+              amount_includes_iof?: MandateOptions.AmountIncludesIof;
+
+              /**
+               * Type of amount. Defaults to `maximum`.
+               */
+              amount_type?: MandateOptions.AmountType;
+
+              /**
+               * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Only `brl` is supported currently.
+               */
+              currency?: string;
+
+              /**
+               * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+               */
+              end_date?: string;
+
+              /**
+               * Schedule at which the future payments will be charged. Defaults to `weekly`.
+               */
+              payment_schedule?: MandateOptions.PaymentSchedule;
+
+              /**
+               * Subscription name displayed to buyers in their bank app. Defaults to the displayable business name.
+               */
+              reference?: string;
+
+              /**
+               * Start date of the mandate, in `YYYY-MM-DD`. Start date should be at least 3 days in the future. Defaults to 3 days after the current date.
+               */
+              start_date?: string;
+            }
+
+            namespace MandateOptions {
+              type AmountIncludesIof = 'always' | 'never';
+
+              type AmountType = 'fixed' | 'maximum';
+
+              type PaymentSchedule =
+                | 'halfyearly'
+                | 'monthly'
+                | 'quarterly'
+                | 'weekly'
+                | 'yearly';
+            }
+
+            type SetupFutureUsage = 'none' | 'off_session';
           }
 
           interface RevolutPay {
@@ -2648,7 +2775,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type SetupFutureUsage = 'none' | 'off_session' | 'on_session';
@@ -2704,6 +2835,7 @@ declare module 'stripe' {
           | 'eps'
           | 'fpx'
           | 'giropay'
+          | 'gopay'
           | 'grabpay'
           | 'ideal'
           | 'kakao_pay'
@@ -2722,13 +2854,17 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'paypay'
           | 'payto'
           | 'pix'
           | 'promptpay'
+          | 'qris'
+          | 'rechnung'
           | 'revolut_pay'
           | 'samsung_pay'
           | 'satispay'
           | 'sepa_debit'
+          | 'shopeepay'
           | 'sofort'
           | 'swish'
           | 'twint'
@@ -2737,6 +2873,27 @@ declare module 'stripe' {
           | 'zip';
 
         interface Permissions {
+          /**
+           * Permissions for updating the Checkout Session.
+           */
+          update?: Permissions.Update;
+
+          /**
+           * Determines which entity is allowed to update the discounts (coupons or promotion codes) that apply to this session.
+           *
+           * Default is `client_only`. Stripe Checkout client will automatically handle discount updates. If set to `server_only`, only your server is allowed to update discounts.
+           */
+          update_discounts?: Permissions.UpdateDiscounts;
+
+          /**
+           * Determines which entity is allowed to update the line items.
+           *
+           * Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
+           *
+           * When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
+           */
+          update_line_items?: Permissions.UpdateLineItems;
+
           /**
            * Determines which entity is allowed to update the shipping details.
            *
@@ -2748,6 +2905,36 @@ declare module 'stripe' {
         }
 
         namespace Permissions {
+          interface Update {
+            /**
+             * Determines which entity is allowed to update the line items.
+             *
+             * Default is `client_only`. Stripe Checkout client will automatically update the line items. If set to `server_only`, only your server is allowed to update the line items.
+             *
+             * When set to `server_only`, you must add the onLineItemsChange event handler when initializing the Stripe Checkout client and manually update the line items from your server using the Stripe API.
+             */
+            line_items?: Update.LineItems;
+
+            /**
+             * Determines which entity is allowed to update the shipping details.
+             *
+             * Default is `client_only`. Stripe Checkout client will automatically update the shipping details. If set to `server_only`, only your server is allowed to update the shipping details.
+             *
+             * When set to `server_only`, you must add the onShippingDetailsChange event handler when initializing the Stripe Checkout client and manually update the shipping details from your server using the Stripe API.
+             */
+            shipping_details?: Update.ShippingDetails;
+          }
+
+          namespace Update {
+            type LineItems = 'client_only' | 'server_only';
+
+            type ShippingDetails = 'client_only' | 'server_only';
+          }
+
+          type UpdateDiscounts = 'client_only' | 'server_only';
+
+          type UpdateLineItems = 'client_only' | 'server_only';
+
           type UpdateShippingDetails = 'client_only' | 'server_only';
         }
 
@@ -3402,16 +3589,31 @@ declare module 'stripe' {
       }
 
       interface SessionUpdateParams {
+        /**
+         * Settings for automatic tax lookup for this session and resulting payments, invoices, and subscriptions.
+         */
+        automatic_tax?: SessionUpdateParams.AutomaticTax;
+
         /**
          * Information about the customer collected within the Checkout Session. Can only be set when updating `embedded` or `custom` sessions.
          */
         collected_information?: SessionUpdateParams.CollectedInformation;
 
+        /**
+         * List of coupons and promotion codes attached to the Checkout Session.
+         */
+        discounts?: Stripe.Emptyable<Array<SessionUpdateParams.Discount>>;
+
         /**
          * Specifies which fields in the response should be expanded.
          */
         expand?: Array<string>;
 
+        /**
+         * Generate a post-purchase Invoice for one-time payments.
+         */
+        invoice_creation?: SessionUpdateParams.InvoiceCreation;
+
         /**
          * A list of items the customer is purchasing.
          *
@@ -3440,9 +3642,39 @@ declare module 'stripe' {
         shipping_options?: Stripe.Emptyable<
           Array<SessionUpdateParams.ShippingOption>
         >;
+
+        /**
+         * A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.
+         */
+        subscription_data?: SessionUpdateParams.SubscriptionData;
       }
 
       namespace SessionUpdateParams {
+        interface AutomaticTax {
+          /**
+           * The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
+           */
+          liability?: AutomaticTax.Liability;
+        }
+
+        namespace AutomaticTax {
+          interface Liability {
+            /**
+             * The connected account being referenced when `type` is `account`.
+             */
+            account?: string;
+
+            /**
+             * Type of the account referenced in the request.
+             */
+            type: Liability.Type;
+          }
+
+          namespace Liability {
+            type Type = 'account' | 'self';
+          }
+        }
+
         interface CollectedInformation {
           /**
            * The shipping details to apply to this Session.
@@ -3498,6 +3730,90 @@ declare module 'stripe' {
           }
         }
 
+        interface Discount {
+          /**
+           * The ID of the [Coupon](https://docs.stripe.com/api/coupons) to apply to this Session. One of `coupon` or `coupon_data` is required when updating discounts.
+           */
+          coupon?: string;
+
+          /**
+           * Data used to generate a new [Coupon](https://docs.stripe.com/api/coupon) object inline. One of `coupon` or `coupon_data` is required when updating discounts.
+           */
+          coupon_data?: Discount.CouponData;
+        }
+
+        namespace Discount {
+          interface CouponData {
+            /**
+             * A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed).
+             */
+            amount_off?: number;
+
+            /**
+             * Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).
+             */
+            currency?: string;
+
+            /**
+             * Specifies how long the discount will be in effect if used on a subscription. Defaults to `once`.
+             */
+            duration?: CouponData.Duration;
+
+            /**
+             * 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>;
+
+            /**
+             * Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.
+             */
+            name?: string;
+
+            /**
+             * A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).
+             */
+            percent_off?: number;
+          }
+
+          namespace CouponData {
+            type Duration = 'forever' | 'once' | 'repeating';
+          }
+        }
+
+        interface InvoiceCreation {
+          /**
+           * Parameters passed when creating invoices for payment-mode Checkout Sessions.
+           */
+          invoice_data?: InvoiceCreation.InvoiceData;
+        }
+
+        namespace InvoiceCreation {
+          interface InvoiceData {
+            /**
+             * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
+             */
+            issuer?: InvoiceData.Issuer;
+          }
+
+          namespace InvoiceData {
+            interface Issuer {
+              /**
+               * The connected account being referenced when `type` is `account`.
+               */
+              account?: string;
+
+              /**
+               * Type of the account referenced in the request.
+               */
+              type: Issuer.Type;
+            }
+
+            namespace Issuer {
+              type Type = 'account' | 'self';
+            }
+          }
+        }
+
         interface LineItem {
           /**
            * When set, provides configuration for this item's quantity to be adjusted by the customer during Checkout.
@@ -3780,6 +4096,50 @@ declare module 'stripe' {
             type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
           }
         }
+
+        interface SubscriptionData {
+          /**
+           * All invoices will be billed using the specified settings.
+           */
+          invoice_settings?: SubscriptionData.InvoiceSettings;
+
+          /**
+           * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.
+           */
+          trial_end?: number;
+
+          /**
+           * Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
+           */
+          trial_period_days?: Stripe.Emptyable<number>;
+        }
+
+        namespace SubscriptionData {
+          interface InvoiceSettings {
+            /**
+             * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
+             */
+            issuer?: InvoiceSettings.Issuer;
+          }
+
+          namespace InvoiceSettings {
+            interface Issuer {
+              /**
+               * The connected account being referenced when `type` is `account`.
+               */
+              account?: string;
+
+              /**
+               * Type of the account referenced in the request.
+               */
+              type: Issuer.Type;
+            }
+
+            namespace Issuer {
+              type Type = 'account' | 'self';
+            }
+          }
+        }
       }
 
       interface SessionListParams extends PaginationParams {