stripe 18.1.0.pre.beta.1 → 18.1.0

data/lib/stripe/resources/balance.rb

@@ -7,7 +7,7 @@ module Stripe
   #
   # The top-level `available` and `pending` comprise your "payments balance."
   #
-  # Related guide: [Balances and settlement time](https://stripe.com/docs/payments/balances), [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
+  # Related guide: [Balances and settlement time](https://docs.stripe.com/payments/balances), [Understanding Connect account balances](https://docs.stripe.com/connect/account-balances)
   class Balance < SingletonAPIResource
     OBJECT_NAME = "balance"
     def self.object_name
@@ -305,7 +305,7 @@ module Stripe
         @field_remappings = {}
       end
     end
-    # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
+    # Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://api.stripe.com#transfers) or [Payouts API](https://api.stripe.com#payouts). You can find the available balance for each currency and payment type in the `source_types` property.
     attr_reader :available
     # Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.
     attr_reader :connect_reserved

data/lib/stripe/resources/balance_settings.rb

@@ -31,7 +31,7 @@ module Stripe
         end
         # The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).
         attr_reader :minimum_balance_by_currency
-        # Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://stripe.com/docs/connect/bank-transfers#payout-information) documentation for details.
+        # Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details.
         attr_reader :schedule
         # The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard.
         attr_reader :statement_descriptor

data/lib/stripe/resources/balance_transaction.rb

@@ -5,7 +5,7 @@ module Stripe
   # Balance transactions represent funds moving through your Stripe account.
   # Stripe creates them for every type of transaction that enters or leaves your Stripe account balance.
   #
-  # Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
+  # Related guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)
   class BalanceTransaction < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/bank_account.rb

@@ -36,13 +36,13 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      # Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
       attr_reader :currently_due
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
-      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types
@@ -71,13 +71,13 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      # Fields that need to be resolved to keep the external account enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the account is disabled.
       attr_reader :currently_due
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
-      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the external account.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types
@@ -110,13 +110,13 @@ module Stripe
     attr_reader :default_for_currency
     # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
     attr_reader :fingerprint
-    # Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
+    # Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
     attr_reader :future_requirements
     # Unique identifier for the object.
     attr_reader :id
     # The last four digits of the bank account number.
     attr_reader :last4
-    # 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.
     attr_reader :metadata
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object

data/lib/stripe/resources/billing/alert.rb

@@ -57,7 +57,7 @@ module Stripe
       attr_reader :status
       # Title of the alert.
       attr_reader :title
-      # Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
+      # Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter).
       attr_reader :usage_threshold
 
       # Reactivates this alert, allowing it to trigger again.

data/lib/stripe/resources/billing/credit_grant.rb

@@ -93,7 +93,7 @@ module Stripe
       attr_reader :created
       # ID of the customer receiving the billing credits.
       attr_reader :customer
-      # ID of the account receiving the billing credits
+      # ID of the account representing the customer receiving the billing credits
       attr_reader :customer_account
       # The time when the billing credits become effective-when they're eligible for use.
       attr_reader :effective_at
@@ -103,7 +103,7 @@ module Stripe
       attr_reader :id
       # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
       attr_reader :livemode
-      # 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.
       attr_reader :metadata
       # A descriptive name shown in dashboard.
       attr_reader :name

data/lib/stripe/resources/billing/meter_event.rb

@@ -22,7 +22,7 @@ module Stripe
       attr_reader :livemode
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-      # The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+      # The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).
       attr_reader :payload
       # The timestamp passed in when creating the event. Measured in seconds since the Unix epoch.
       attr_reader :timestamp

data/lib/stripe/resources/billing_portal/configuration.rb

@@ -166,6 +166,8 @@ module Stripe
               @field_remappings = {}
             end
           end
+          # Determines the value to use for the billing cycle anchor on subscription updates. Valid values are `now` or `unchanged`, and the default value is `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
+          attr_reader :billing_cycle_anchor
           # The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable.
           attr_reader :default_allowed_updates
           # Whether the feature is enabled.
@@ -218,7 +220,7 @@ module Stripe
         #
         # If `false`, the previously generated `url`, if any, will be deactivated.
         attr_reader :enabled
-        # A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal.
+        # A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://docs.stripe.com/api/customers/object#customer_object-email) and receive a link to their customer portal.
         attr_reader :url
 
         def self.inner_class_types
@@ -237,7 +239,7 @@ module Stripe
       attr_reader :business_profile
       # Time at which the object was created. Measured in seconds since the Unix epoch.
       attr_reader :created
-      # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
+      # The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://docs.stripe.com/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session.
       attr_reader :default_return_url
       # Attribute for field features
       attr_reader :features
@@ -249,7 +251,7 @@ module Stripe
       attr_reader :livemode
       # Attribute for field login_page
       attr_reader :login_page
-      # 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.
       attr_reader :metadata
       # The name of the configuration.
       attr_reader :name

data/lib/stripe/resources/billing_portal/session.rb

@@ -139,11 +139,11 @@ module Stripe
           end
 
           class Item < ::Stripe::StripeObject
-            # The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+            # The ID of the [subscription item](https://docs.stripe.com/api/subscriptions/object#subscription_object-items-data-id) to be updated.
             attr_reader :id
-            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+            # The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://docs.stripe.com/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
             attr_reader :price
-            # [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+            # [Quantity](https://docs.stripe.com/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
             attr_reader :quantity
 
             def self.inner_class_types
@@ -156,7 +156,7 @@ module Stripe
           end
           # The coupon or promotion code to apply to this subscription update.
           attr_reader :discounts
-          # The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+          # The [subscription item](https://docs.stripe.com/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
           attr_reader :items
           # The ID of the subscription to be updated.
           attr_reader :subscription
@@ -201,7 +201,7 @@ module Stripe
       attr_reader :customer
       # The ID of the account for this session.
       attr_reader :customer_account
-      # Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
+      # Information about a specific flow for the customer to go through. See the [docs](https://docs.stripe.com/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows.
       attr_reader :flow
       # Unique identifier for the object.
       attr_reader :id
@@ -211,7 +211,7 @@ module Stripe
       attr_reader :locale
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object
-      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
+      # The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://docs.stripe.com/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://docs.stripe.com/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays.
       attr_reader :on_behalf_of
       # The URL to redirect customers to when they click on the portal's link to return to your website.
       attr_reader :return_url

data/lib/stripe/resources/capability.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This is an object representing a capability for a Stripe account.
   #
-  # Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
+  # Related guide: [Account capabilities](https://docs.stripe.com/connect/account-capabilities)
   class Capability < APIResource
     include Stripe::APIOperations::Save
 
@@ -15,9 +15,9 @@ module Stripe
 
     class FutureRequirements < ::Stripe::StripeObject
       class Alternative < ::Stripe::StripeObject
-        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        # Fields that can be provided to resolve all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
-        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        # Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
         attr_reader :original_fields_due
 
         def self.inner_class_types
@@ -45,21 +45,21 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      # Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
       attr_reader :alternatives
       # Date on which `future_requirements` becomes the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning.
       attr_reader :current_deadline
-      # Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
+      # Fields that need to be resolved to keep the capability enabled. If not resolved by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash.
       attr_reader :currently_due
       # This is typed as an enum for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is null because fields in `future_requirements` will never disable the account.
       attr_reader :disabled_reason
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
       # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well.
       attr_reader :eventually_due
-      # Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`.
+      # Fields that haven't been resolved by `requirements.current_deadline`. These fields need to be resolved to enable the capability on the account. `future_requirements.past_due` is a subset of `requirements.past_due`.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types
@@ -73,9 +73,9 @@ module Stripe
 
     class Requirements < ::Stripe::StripeObject
       class Alternative < ::Stripe::StripeObject
-        # Fields that can be provided to satisfy all fields in `original_fields_due`.
+        # Fields that can be provided to resolve all fields in `original_fields_due`.
         attr_reader :alternative_fields_due
-        # Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`.
+        # Fields that are due and can be resolved by providing all fields in `alternative_fields_due`.
         attr_reader :original_fields_due
 
         def self.inner_class_types
@@ -103,21 +103,21 @@ module Stripe
           @field_remappings = {}
         end
       end
-      # Fields that are due and can be satisfied by providing the corresponding alternative fields instead.
+      # Fields that are due and can be resolved by providing the corresponding alternative fields instead. Multiple alternatives can reference the same `original_fields_due`. When this happens, any of these alternatives can serve as a pathway for attempting to resolve the fields. Additionally, providing `original_fields_due` again also serves as a pathway for attempting to resolve the fields.
       attr_reader :alternatives
       # The date by which all required account information must be both submitted and verified. This includes fields listed in `currently_due` as well as those in `pending_verification`. If any required information is missing or unverified by this date, the account may be disabled. Note that `current_deadline` may change if additional `currently_due` requirements are requested.
       attr_reader :current_deadline
-      # Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.
+      # Fields that need to be resolved to keep the capability enabled. If not resolved by `current_deadline`, these fields will appear in `past_due` as well, and the capability is disabled.
       attr_reader :currently_due
-      # Description of why the capability is disabled. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification).
+      # Description of why the capability is disabled. [Learn more about handling verification issues](https://docs.stripe.com/connect/handling-api-verification).
       attr_reader :disabled_reason
-      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      # Details about validation and verification failures for `due` requirements that must be resolved.
       attr_reader :errors
       # Fields you must collect when all thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set.
       attr_reader :eventually_due
-      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account.
+      # Fields that haven't been resolved by `current_deadline`. These fields need to be resolved to enable the capability on the account.
       attr_reader :past_due
-      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      # Fields that are being reviewed, or might become required depending on the results of a review. If the review fails, these fields can move to `eventually_due`, `currently_due`, `past_due` or `alternatives`. Fields might appear in `eventually_due`, `currently_due`, `past_due` or `alternatives` and in `pending_verification` if one verification fails but another is still pending.
       attr_reader :pending_verification
 
       def self.inner_class_types

data/lib/stripe/resources/card.rb

@@ -6,7 +6,7 @@ module Stripe
   # 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)
+  # Related guide: [Card payments with Sources](https://docs.stripe.com/sources/cards)
   class Card < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
@@ -53,8 +53,6 @@ module Stripe
     attr_reader :available_payout_methods
     # Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.
     attr_reader :brand
-    # The [product code](https://stripe.com/docs/card-product-codes) that identifies the specific program or product associated with a card. (For internal use only and not typically available in standard API requests.)
-    attr_reader :brand_product
     # Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.
     attr_reader :country
     # Three-letter [ISO code for currency](https://www.iso.org/iso-4217-currency-codes.html) in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available when returned as an [External Account](/api/external_account_cards/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.
@@ -87,7 +85,7 @@ module Stripe
     attr_reader :issuer
     # The last four digits of the card.
     attr_reader :last4
-    # 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.
     attr_reader :metadata
     # Cardholder name.
     attr_reader :name

data/lib/stripe/resources/cash_balance.rb

@@ -23,11 +23,11 @@ module Stripe
         @field_remappings = {}
       end
     end
-    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+    # A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal).
     attr_reader :available
     # The ID of the customer whose cash balance this object represents.
     attr_reader :customer
-    # The ID of the account whose cash balance this object represents.
+    # The ID of an Account representing a customer whose cash balance this object represents.
     attr_reader :customer_account
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     attr_reader :livemode