API Updates

OPENAPI_VERSION

@@ -1 +1 @@
-v178
+v183

lib/resources/Customers.js

@@ -92,6 +92,17 @@ module.exports = StripeResource.extend({
     methodType: 'list',
   }),
 
+  retrieveCashBalanceTransaction: stripeMethod({
+    method: 'GET',
+    path: '/{customer}/cash_balance_transactions/{transaction}',
+  }),
+
+  listCashBalanceTransactions: stripeMethod({
+    method: 'GET',
+    path: '/{customer}/cash_balance_transactions',
+    methodType: 'list',
+  }),
+
   createSource: stripeMethod({
     method: 'POST',
     path: '/{customer}/sources',

types/2022-08-01/AccountLinks.d.ts

@@ -3,7 +3,10 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The AccountLink object.
+     * Account Links are the means by which a Connect platform grants a connected account permission to access
+     * Stripe-hosted applications, such as Connect Onboarding.
+     *
+     * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding).
      */
     interface AccountLink {
       /**

types/2022-08-01/Accounts.d.ts

@@ -3,7 +3,12 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Account object.
+     * This is an object representing a Stripe account. You can retrieve it to see
+     * properties on the account like its current e-mail address or if the account is
+     * enabled yet to make live charges.
+     *
+     * Some properties, marked below, are available only to platforms that want to
+     * [create and manage Express or Custom accounts](https://stripe.com/docs/connect/accounts).
      */
     interface Account {
       /**
@@ -1187,7 +1192,7 @@ declare module 'stripe' {
       /**
        * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.
        *
-       * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
+       * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.
        */
       external_account?: string | AccountCreateParams.ExternalAccount;
 
@@ -2407,7 +2412,7 @@ declare module 'stripe' {
       /**
        * A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.
        *
-       * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the bank account or card creation API.
+       * By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs.
        */
       external_account?: string;
 

types/2022-08-01/Apps/Secrets.d.ts

@@ -4,7 +4,15 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Apps {
       /**
-       * The Secret object.
+       * Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+       *
+       * The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+       *
+       * All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+       *
+       * A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+       *
+       * Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects).
        */
       interface Secret {
         /**

types/2022-08-01/Balance.d.ts

@@ -3,7 +3,17 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Balance object.
+     * This is an object representing your Stripe balance. You can retrieve it to see
+     * the balance currently on your Stripe account.
+     *
+     * You can also retrieve the balance history, which contains a list of
+     * [transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance
+     * (charges, payouts, and so forth).
+     *
+     * The available and pending amounts for each currency are broken down further by
+     * payment source types.
+     *
+     * Related guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
      */
     interface Balance {
       /**

types/2022-08-01/BalanceTransactions.d.ts

@@ -3,7 +3,10 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The BalanceTransaction object.
+     * Balance transactions represent funds moving through your Stripe account.
+     * They're created for every type of transaction that comes into or flows out of your Stripe account balance.
+     *
+     * Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).
      */
     interface BalanceTransaction {
       /**

types/2022-08-01/BankAccounts.d.ts

@@ -3,7 +3,13 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The BankAccount object.
+     * These bank accounts are payment methods on `Customer` objects.
+     *
+     * On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer
+     * destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
+     * They can be bank accounts or debit cards as well, and are documented in the links above.
+     *
+     * Related guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers).
      */
     interface BankAccount {
       /**

types/2022-08-01/BillingPortal/Configurations.d.ts

@@ -4,7 +4,7 @@ declare module 'stripe' {
   namespace Stripe {
     namespace BillingPortal {
       /**
-       * The Configuration object.
+       * A portal configuration describes the functionality and behavior of a portal session.
        */
       interface Configuration {
         /**

types/2022-08-01/BillingPortal/Sessions.d.ts

@@ -4,7 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace BillingPortal {
       /**
-       * The Session object.
+       * The Billing customer portal is a Stripe-hosted UI for subscription and
+       * billing management.
+       *
+       * A portal configuration describes the functionality and features that you
+       * want to provide to your customers through the portal.
+       *
+       * A portal session describes the instantiation of the customer portal for
+       * a particular customer. By visiting the session's URL, the customer
+       * can manage their subscriptions and billing details. For security reasons,
+       * sessions are short-lived and will expire if the customer does not visit the URL.
+       * Create sessions on-demand when customers intend to manage their subscriptions
+       * and billing details.
+       *
+       * Learn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal).
        */
       interface Session {
         /**

types/2022-08-01/Capabilities.d.ts

@@ -3,7 +3,9 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Capability object.
+     * This is an object representing a capability for a Stripe account.
+     *
+     * Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).
      */
     interface Capability {
       /**

types/2022-08-01/Cards.d.ts

@@ -3,7 +3,11 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Card object.
+     * You can store multiple cards on a customer in order to charge the customer
+     * later. You can also store multiple debit cards on a recipient in order to
+     * transfer to those cards later.
+     *
+     * Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).
      */
     interface Card {
       /**

types/2022-08-01/CashBalances.d.ts

@@ -3,7 +3,7 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The CashBalance object.
+     * A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.
      */
     interface CashBalance {
       /**

types/2022-08-01/Charges.d.ts

@@ -3,7 +3,11 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Charge object.
+     * To charge a credit or a debit card, you create a `Charge` object. You can
+     * retrieve and refund individual charges as well as list all charges. Charges
+     * are identified by a unique, random ID.
+     *
+     * Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
      */
     interface Charge {
       /**

types/2022-08-01/Checkout/Sessions.d.ts

@@ -4,7 +4,20 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Checkout {
       /**
-       * The Session object.
+       * A Checkout Session represents your customer's session as they pay for
+       * one-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)
+       * or [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a
+       * new Session each time your customer attempts to pay.
+       *
+       * Once payment is successful, the Checkout Session will contain a reference
+       * to the [Customer](https://stripe.com/docs/api/customers), and either the successful
+       * [PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active
+       * [Subscription](https://stripe.com/docs/api/subscriptions).
+       *
+       * You can create a Checkout Session on your server and pass its ID to the
+       * client to begin Checkout.
+       *
+       * Related guide: [Checkout Quickstart](https://stripe.com/docs/checkout/quickstart).
        */
       interface Session {
         /**

types/2022-08-01/CountrySpecs.d.ts

@@ -3,7 +3,12 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The CountrySpec object.
+     * Stripe needs to collect certain pieces of information about each account
+     * created. These requirements can differ depending on the account's country. The
+     * Country Specs API makes these rules available to your integration.
+     *
+     * You can also view the information from this API call as [an online
+     * guide](https://stripe.com/docs/connect/required-verification-information).
      */
     interface CountrySpec {
       /**

types/2022-08-01/Coupons.d.ts

@@ -3,7 +3,9 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The Coupon object.
+     * A coupon contains information about a percent-off or amount-off discount you
+     * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+     * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
      */
     interface Coupon {
       /**

types/2022-08-01/CreditNotes.d.ts

@@ -3,7 +3,9 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The CreditNote object.
+     * Issue a credit note to adjust an invoice's amount after the invoice is finalized.
+     *
+     * Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).
      */
     interface CreditNote {
       /**

types/2022-08-01/CustomerBalanceTransactions.d.ts

@@ -3,7 +3,12 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * The CustomerBalanceTransaction object.
+     * Each customer has a [`balance`](https://stripe.com/docs/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://stripe.com/docs/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://stripe.com/docs/billing/customer/balance) to learn more.
      */
     interface CustomerBalanceTransaction {
       /**