@depup/stripe 21.0.0-depup.0

package/types/CustomerBalanceTransactions.d.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Each customer has a [Balance](https://docs.stripe.com/api/customers/object#customer_object-balance) value,
+     * which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
+     * You may modify the value directly by using the [update customer API](https://docs.stripe.com/api/customers/update),
+     * or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
+     *
+     * Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance)
+     */
+    interface CustomerBalanceTransaction {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'customer_balance_transaction';
+
+      /**
+       * The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
+       */
+      amount: number;
+
+      /**
+       * The ID of the checkout session (if any) that created the transaction.
+       */
+      checkout_session: string | Stripe.Checkout.Session | null;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The ID of the credit note (if any) related to the transaction.
+       */
+      credit_note: string | Stripe.CreditNote | 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).
+       */
+      currency: string;
+
+      /**
+       * The ID of the customer the transaction belongs to.
+       */
+      customer: string | Stripe.Customer;
+
+      /**
+       * The ID of an Account representing a customer that the transaction belongs to.
+       */
+      customer_account: string | null;
+
+      /**
+       * An arbitrary string attached to the object. Often useful for displaying to users.
+       */
+      description: string | null;
+
+      /**
+       * The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
+       */
+      ending_balance: number;
+
+      /**
+       * The ID of the invoice (if any) related to the transaction.
+       */
+      invoice: string | Stripe.Invoice | null;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * 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;
+
+      /**
+       * Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, `unapplied_from_invoice`, `checkout_session_subscription_payment`, or `checkout_session_subscription_payment_canceled`. See the [Customer Balance page](https://docs.stripe.com/billing/customer/balance#types) to learn more about transaction types.
+       */
+      type: CustomerBalanceTransaction.Type;
+    }
+
+    namespace CustomerBalanceTransaction {
+      type Type =
+        | 'adjustment'
+        | 'applied_to_invoice'
+        | 'checkout_session_subscription_payment'
+        | 'checkout_session_subscription_payment_canceled'
+        | 'credit_note'
+        | 'initial'
+        | 'invoice_overpaid'
+        | 'invoice_too_large'
+        | 'invoice_too_small'
+        | 'migration'
+        | 'unapplied_from_invoice'
+        | 'unspent_receiver_credit';
+    }
+  }
+}

package/types/CustomerCashBalanceTransactions.d.ts

@@ -0,0 +1,230 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * Customers with certain payments enabled have a cash balance, representing funds that were paid
+     * by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
+     * represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
+     * to payments, and refunds to the customer.
+     */
+    interface CustomerCashBalanceTransaction {
+      /**
+       * Unique identifier for the object.
+       */
+      id: string;
+
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'customer_cash_balance_transaction';
+
+      adjusted_for_overdraft?: CustomerCashBalanceTransaction.AdjustedForOverdraft;
+
+      applied_to_payment?: CustomerCashBalanceTransaction.AppliedToPayment;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * 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).
+       */
+      currency: string;
+
+      /**
+       * The customer whose available cash balance changed as a result of this transaction.
+       */
+      customer: string | Stripe.Customer;
+
+      /**
+       * The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.
+       */
+      customer_account: string | null;
+
+      /**
+       * The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
+       */
+      ending_balance: number;
+
+      funded?: CustomerCashBalanceTransaction.Funded;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+
+      /**
+       * The amount by which the cash balance changed, represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
+       */
+      net_amount: number;
+
+      refunded_from_payment?: CustomerCashBalanceTransaction.RefundedFromPayment;
+
+      transferred_to_balance?: CustomerCashBalanceTransaction.TransferredToBalance;
+
+      /**
+       * The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://docs.stripe.com/payments/customer-balance#types) to learn more about these types.
+       */
+      type: CustomerCashBalanceTransaction.Type;
+
+      unapplied_from_payment?: CustomerCashBalanceTransaction.UnappliedFromPayment;
+    }
+
+    namespace CustomerCashBalanceTransaction {
+      interface AdjustedForOverdraft {
+        /**
+         * The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
+         */
+        balance_transaction: string | Stripe.BalanceTransaction;
+
+        /**
+         * The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
+         */
+        linked_transaction: string | Stripe.CustomerCashBalanceTransaction;
+      }
+
+      interface AppliedToPayment {
+        /**
+         * The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.
+         */
+        payment_intent: string | Stripe.PaymentIntent;
+      }
+
+      interface Funded {
+        bank_transfer: Funded.BankTransfer;
+      }
+
+      namespace Funded {
+        interface BankTransfer {
+          eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
+          gb_bank_transfer?: BankTransfer.GbBankTransfer;
+
+          jp_bank_transfer?: BankTransfer.JpBankTransfer;
+
+          /**
+           * The user-supplied reference field on the bank transfer.
+           */
+          reference: string | null;
+
+          /**
+           * The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
+           */
+          type: BankTransfer.Type;
+
+          us_bank_transfer?: BankTransfer.UsBankTransfer;
+        }
+
+        namespace BankTransfer {
+          interface EuBankTransfer {
+            /**
+             * The BIC of the bank of the sender of the funding.
+             */
+            bic: string | null;
+
+            /**
+             * The last 4 digits of the IBAN of the sender of the funding.
+             */
+            iban_last4: string | null;
+
+            /**
+             * The full name of the sender, as supplied by the sending bank.
+             */
+            sender_name: string | null;
+          }
+
+          interface GbBankTransfer {
+            /**
+             * The last 4 digits of the account number of the sender of the funding.
+             */
+            account_number_last4: string | null;
+
+            /**
+             * The full name of the sender, as supplied by the sending bank.
+             */
+            sender_name: string | null;
+
+            /**
+             * The sort code of the bank of the sender of the funding
+             */
+            sort_code: string | null;
+          }
+
+          interface JpBankTransfer {
+            /**
+             * The name of the bank of the sender of the funding.
+             */
+            sender_bank: string | null;
+
+            /**
+             * The name of the bank branch of the sender of the funding.
+             */
+            sender_branch: string | null;
+
+            /**
+             * The full name of the sender, as supplied by the sending bank.
+             */
+            sender_name: string | null;
+          }
+
+          type Type =
+            | 'eu_bank_transfer'
+            | 'gb_bank_transfer'
+            | 'jp_bank_transfer'
+            | 'mx_bank_transfer'
+            | 'us_bank_transfer';
+
+          interface UsBankTransfer {
+            /**
+             * The banking network used for this funding.
+             */
+            network?: UsBankTransfer.Network;
+
+            /**
+             * The full name of the sender, as supplied by the sending bank.
+             */
+            sender_name: string | null;
+          }
+
+          namespace UsBankTransfer {
+            type Network = 'ach' | 'domestic_wire_us' | 'swift';
+          }
+        }
+      }
+
+      interface RefundedFromPayment {
+        /**
+         * The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.
+         */
+        refund: string | Stripe.Refund;
+      }
+
+      interface TransferredToBalance {
+        /**
+         * The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
+         */
+        balance_transaction: string | Stripe.BalanceTransaction;
+      }
+
+      type Type =
+        | 'adjusted_for_overdraft'
+        | 'applied_to_payment'
+        | 'funded'
+        | 'funding_reversed'
+        | 'refunded_from_payment'
+        | 'return_canceled'
+        | 'return_initiated'
+        | 'transferred_to_balance'
+        | 'unapplied_from_payment';
+
+      interface UnappliedFromPayment {
+        /**
+         * The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.
+         */
+        payment_intent: string | Stripe.PaymentIntent;
+      }
+    }
+  }
+}

package/types/CustomerSessions.d.ts

@@ -0,0 +1,283 @@
+// File generated from our OpenAPI spec
+
+declare module 'stripe' {
+  namespace Stripe {
+    /**
+     * A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
+     * control over a Customer.
+     *
+     * Related guides: [Customer Session with the Payment Element](https://docs.stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
+     * [Customer Session with the Pricing Table](https://docs.stripe.com/payments/checkout/pricing-table#customer-session),
+     * [Customer Session with the Buy Button](https://docs.stripe.com/payment-links/buy-button#pass-an-existing-customer).
+     */
+    interface CustomerSession {
+      /**
+       * String representing the object's type. Objects of the same type share the same value.
+       */
+      object: 'customer_session';
+
+      /**
+       * The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.
+       *
+       * The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.
+       */
+      client_secret: string;
+
+      /**
+       * Configuration for the components supported by this Customer Session.
+       */
+      components?: CustomerSession.Components;
+
+      /**
+       * Time at which the object was created. Measured in seconds since the Unix epoch.
+       */
+      created: number;
+
+      /**
+       * The Customer the Customer Session was created for.
+       */
+      customer: string | Stripe.Customer;
+
+      /**
+       * The Account that the Customer Session was created for.
+       */
+      customer_account: string | null;
+
+      /**
+       * The timestamp at which this Customer Session will expire.
+       */
+      expires_at: number;
+
+      /**
+       * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
+       */
+      livemode: boolean;
+    }
+
+    namespace CustomerSession {
+      interface Components {
+        /**
+         * This hash contains whether the buy button is enabled.
+         */
+        buy_button: Components.BuyButton;
+
+        /**
+         * This hash contains whether the customer sheet is enabled and the features it supports.
+         */
+        customer_sheet: Components.CustomerSheet;
+
+        /**
+         * This hash contains whether the mobile payment element is enabled and the features it supports.
+         */
+        mobile_payment_element: Components.MobilePaymentElement;
+
+        /**
+         * This hash contains whether the Payment Element is enabled and the features it supports.
+         */
+        payment_element: Components.PaymentElement;
+
+        /**
+         * This hash contains whether the pricing table is enabled.
+         */
+        pricing_table: Components.PricingTable;
+      }
+
+      namespace Components {
+        interface BuyButton {
+          /**
+           * Whether the buy button is enabled.
+           */
+          enabled: boolean;
+        }
+
+        interface CustomerSheet {
+          /**
+           * Whether the customer sheet is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the customer sheet supports certain features.
+           */
+          features: CustomerSheet.Features | null;
+        }
+
+        namespace CustomerSheet {
+          interface Features {
+            /**
+             * A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the customer sheet displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+             *
+             * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+             */
+            payment_method_allow_redisplay_filters: Array<
+              Features.PaymentMethodAllowRedisplayFilter
+            > | null;
+
+            /**
+             * Controls whether the customer sheet displays the option to remove a saved payment method."
+             *
+             * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+             */
+            payment_method_remove: Features.PaymentMethodRemove | null;
+          }
+
+          namespace Features {
+            type PaymentMethodAllowRedisplayFilter =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+
+            type PaymentMethodRemove = 'disabled' | 'enabled';
+          }
+        }
+
+        interface MobilePaymentElement {
+          /**
+           * Whether the mobile payment element is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the mobile payment element supports certain features.
+           */
+          features: MobilePaymentElement.Features | null;
+        }
+
+        namespace MobilePaymentElement {
+          interface Features {
+            /**
+             * A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the mobile payment element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+             *
+             * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+             */
+            payment_method_allow_redisplay_filters: Array<
+              Features.PaymentMethodAllowRedisplayFilter
+            > | null;
+
+            /**
+             * Controls whether or not the mobile payment element shows saved payment methods.
+             */
+            payment_method_redisplay: Features.PaymentMethodRedisplay | null;
+
+            /**
+             * Controls whether the mobile payment element displays the option to remove a saved payment method."
+             *
+             * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+             */
+            payment_method_remove: Features.PaymentMethodRemove | null;
+
+            /**
+             * Controls whether the mobile payment element displays a checkbox offering to save a new payment method.
+             *
+             * If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+             */
+            payment_method_save: Features.PaymentMethodSave | null;
+
+            /**
+             * Allows overriding the value of allow_override when saving a new payment method when payment_method_save is set to disabled. Use values: "always", "limited", or "unspecified".
+             *
+             * If not specified, defaults to `nil` (no override value).
+             */
+            payment_method_save_allow_redisplay_override: Features.PaymentMethodSaveAllowRedisplayOverride | null;
+          }
+
+          namespace Features {
+            type PaymentMethodAllowRedisplayFilter =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+
+            type PaymentMethodRedisplay = 'disabled' | 'enabled';
+
+            type PaymentMethodRemove = 'disabled' | 'enabled';
+
+            type PaymentMethodSave = 'disabled' | 'enabled';
+
+            type PaymentMethodSaveAllowRedisplayOverride =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+          }
+        }
+
+        interface PaymentElement {
+          /**
+           * Whether the Payment Element is enabled.
+           */
+          enabled: boolean;
+
+          /**
+           * This hash defines whether the Payment Element supports certain features.
+           */
+          features: PaymentElement.Features | null;
+        }
+
+        namespace PaymentElement {
+          interface Features {
+            /**
+             * A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+             *
+             * If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+             */
+            payment_method_allow_redisplay_filters: Array<
+              Features.PaymentMethodAllowRedisplayFilter
+            >;
+
+            /**
+             * Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
+             */
+            payment_method_redisplay: Features.PaymentMethodRedisplay;
+
+            /**
+             * Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`. The maximum redisplay limit is `10`.
+             */
+            payment_method_redisplay_limit: number | null;
+
+            /**
+             * Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
+             *
+             * Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+             */
+            payment_method_remove: Features.PaymentMethodRemove;
+
+            /**
+             * Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.
+             *
+             * If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+             */
+            payment_method_save: Features.PaymentMethodSave;
+
+            /**
+             * When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.
+             *
+             * When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.
+             */
+            payment_method_save_usage: Features.PaymentMethodSaveUsage | null;
+          }
+
+          namespace Features {
+            type PaymentMethodAllowRedisplayFilter =
+              | 'always'
+              | 'limited'
+              | 'unspecified';
+
+            type PaymentMethodRedisplay = 'disabled' | 'enabled';
+
+            type PaymentMethodRemove = 'disabled' | 'enabled';
+
+            type PaymentMethodSave = 'disabled' | 'enabled';
+
+            type PaymentMethodSaveUsage = 'off_session' | 'on_session';
+          }
+        }
+
+        interface PricingTable {
+          /**
+           * Whether the pricing table is enabled.
+           */
+          enabled: boolean;
+        }
+      }
+    }
+  }
+}