stripe 17.0.1 → 19.0.0

data/lib/stripe/resources/product.rb

@@ -4,12 +4,12 @@
 module Stripe
   # Products describe the specific goods or services you offer to your customers.
   # For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
-  # They can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
+  # They can be used in conjunction with [Prices](https://api.stripe.com#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.
   #
-  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),
-  # [share a Payment Link](https://stripe.com/docs/payment-links),
-  # [accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),
-  # and more about [Products and Prices](https://stripe.com/docs/products-prices/overview)
+  # Related guides: [Set up a subscription](https://docs.stripe.com/billing/subscriptions/set-up-subscription),
+  # [share a Payment Link](https://docs.stripe.com/payment-links),
+  # [accept payments with Checkout](https://docs.stripe.com/payments/accept-a-payment#create-product-prices-upfront),
+  # and more about [Products and Prices](https://docs.stripe.com/products-prices/overview)
   class Product < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -25,7 +25,7 @@ module Stripe
 
     nested_resource_class_methods :feature, operations: %i[create retrieve delete list]
 
-    class MarketingFeature < Stripe::StripeObject
+    class MarketingFeature < ::Stripe::StripeObject
       # The marketing feature name. Up to 80 characters long.
       attr_reader :name
 
@@ -38,7 +38,7 @@ module Stripe
       end
     end
 
-    class PackageDimensions < Stripe::StripeObject
+    class PackageDimensions < ::Stripe::StripeObject
       # Height, in inches.
       attr_reader :height
       # Length, in inches.
@@ -60,7 +60,7 @@ module Stripe
     attr_reader :active
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     attr_reader :created
-    # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
+    # The ID of the [Price](https://docs.stripe.com/api/prices) object that is the default price for this product.
     attr_reader :default_price
     # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
     attr_reader :description
@@ -68,11 +68,11 @@ module Stripe
     attr_reader :id
     # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
     attr_reader :images
-    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     attr_reader :livemode
-    # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
+    # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://docs.stripe.com/payments/checkout/pricing-table).
     attr_reader :marketing_features
-    # 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 product's name, meant to be displayable to the customer.
     attr_reader :name
@@ -84,7 +84,7 @@ module Stripe
     attr_reader :shippable
     # Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments.
     attr_reader :statement_descriptor
-    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+    # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
     attr_reader :tax_code
     # The type of the product. The product is either of type `good`, which is eligible for use with Orders and SKUs, or `service`, which is eligible for use with Subscriptions and Plans.
     attr_reader :type

data/lib/stripe/resources/product_feature.rb

@@ -15,7 +15,7 @@ module Stripe
     attr_reader :entitlement_feature
     # Unique identifier for the object.
     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.
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     attr_reader :livemode
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object

data/lib/stripe/resources/promotion_code.rb

@@ -5,7 +5,7 @@ module Stripe
   # A Promotion Code represents a customer-redeemable code for an underlying promotion.
   # You can create multiple codes for a single promotion.
   #
-  # If you enable promotion codes in your [customer portal configuration](https://stripe.com/docs/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
+  # If you enable promotion codes in your [customer portal configuration](https://docs.stripe.com/customer-management/configure-portal), then customers can redeem a code themselves when updating a subscription in the portal.
   # Customers can also view the currently active promotion codes and coupons on each of their subscriptions in the portal.
   class PromotionCode < APIResource
     extend Stripe::APIOperations::Create
@@ -17,7 +17,7 @@ module Stripe
       "promotion_code"
     end
 
-    class Promotion < Stripe::StripeObject
+    class Promotion < ::Stripe::StripeObject
       # If promotion `type` is `coupon`, the coupon for this promotion.
       attr_reader :coupon
       # The type of promotion.
@@ -32,8 +32,8 @@ module Stripe
       end
     end
 
-    class Restrictions < Stripe::StripeObject
-      class CurrencyOptions < Stripe::StripeObject
+    class Restrictions < ::Stripe::StripeObject
+      class CurrencyOptions < ::Stripe::StripeObject
         # Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work).
         attr_reader :minimum_amount
 
@@ -64,21 +64,23 @@ module Stripe
     end
     # Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid.
     attr_reader :active
-    # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), and digits (0-9).
+    # The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer. Valid characters are lower case letters (a-z), upper case letters (A-Z), digits (0-9), and dashes (-).
     attr_reader :code
     # Time at which the object was created. Measured in seconds since the Unix epoch.
     attr_reader :created
-    # The customer that this promotion code can be used by.
+    # The customer who can use this promotion code.
     attr_reader :customer
+    # The account representing the customer who can use this promotion code.
+    attr_reader :customer_account
     # Date at which the promotion code can no longer be redeemed.
     attr_reader :expires_at
     # Unique identifier for the object.
     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.
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     attr_reader :livemode
     # Maximum number of times this promotion code can be redeemed.
     attr_reader :max_redemptions
-    # 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/quote.rb

@@ -14,8 +14,8 @@ module Stripe
       "quote"
     end
 
-    class AutomaticTax < Stripe::StripeObject
-      class Liability < Stripe::StripeObject
+    class AutomaticTax < ::Stripe::StripeObject
+      class Liability < ::Stripe::StripeObject
         # The connected account being referenced when `type` is `account`.
         attr_reader :account
         # Type of the account referenced.
@@ -47,17 +47,17 @@ module Stripe
       end
     end
 
-    class Computed < Stripe::StripeObject
-      class Recurring < Stripe::StripeObject
-        class TotalDetails < Stripe::StripeObject
-          class Breakdown < Stripe::StripeObject
-            class Discount < Stripe::StripeObject
+    class Computed < ::Stripe::StripeObject
+      class Recurring < ::Stripe::StripeObject
+        class TotalDetails < ::Stripe::StripeObject
+          class Breakdown < ::Stripe::StripeObject
+            class Discount < ::Stripe::StripeObject
               # The amount discounted.
               attr_reader :amount
-              # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+              # A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
               # It contains information about when the discount began, when it will end, and what it is applied to.
               #
-              # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
+              # Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
               attr_reader :discount
 
               def self.inner_class_types
@@ -69,7 +69,7 @@ module Stripe
               end
             end
 
-            class Tax < Stripe::StripeObject
+            class Tax < ::Stripe::StripeObject
               # Amount of tax applied for this rate.
               attr_reader :amount
               # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
@@ -139,16 +139,16 @@ module Stripe
         end
       end
 
-      class Upfront < Stripe::StripeObject
-        class TotalDetails < Stripe::StripeObject
-          class Breakdown < Stripe::StripeObject
-            class Discount < Stripe::StripeObject
+      class Upfront < ::Stripe::StripeObject
+        class TotalDetails < ::Stripe::StripeObject
+          class Breakdown < ::Stripe::StripeObject
+            class Discount < ::Stripe::StripeObject
               # The amount discounted.
               attr_reader :amount
-              # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+              # A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
               # It contains information about when the discount began, when it will end, and what it is applied to.
               #
-              # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
+              # Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
               attr_reader :discount
 
               def self.inner_class_types
@@ -160,7 +160,7 @@ module Stripe
               end
             end
 
-            class Tax < Stripe::StripeObject
+            class Tax < ::Stripe::StripeObject
               # Amount of tax applied for this rate.
               attr_reader :amount
               # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
@@ -241,7 +241,7 @@ module Stripe
       end
     end
 
-    class FromQuote < Stripe::StripeObject
+    class FromQuote < ::Stripe::StripeObject
       # Whether this quote is a revision of a different quote.
       attr_reader :is_revision
       # The quote that was cloned.
@@ -256,8 +256,8 @@ module Stripe
       end
     end
 
-    class InvoiceSettings < Stripe::StripeObject
-      class Issuer < Stripe::StripeObject
+    class InvoiceSettings < ::Stripe::StripeObject
+      class Issuer < ::Stripe::StripeObject
         # The connected account being referenced when `type` is `account`.
         attr_reader :account
         # Type of the account referenced.
@@ -285,7 +285,7 @@ module Stripe
       end
     end
 
-    class StatusTransitions < Stripe::StripeObject
+    class StatusTransitions < ::Stripe::StripeObject
       # The time that the quote was accepted. Measured in seconds since Unix epoch.
       attr_reader :accepted_at
       # The time that the quote was canceled. Measured in seconds since Unix epoch.
@@ -302,9 +302,9 @@ module Stripe
       end
     end
 
-    class SubscriptionData < Stripe::StripeObject
-      class BillingMode < Stripe::StripeObject
-        class Flexible < Stripe::StripeObject
+    class SubscriptionData < ::Stripe::StripeObject
+      class BillingMode < ::Stripe::StripeObject
+        class Flexible < ::Stripe::StripeObject
           # Controls how invoices and invoice items display proration amounts and discount amounts.
           attr_reader :proration_discounts
 
@@ -335,7 +335,7 @@ module Stripe
       attr_reader :description
       # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
       attr_reader :effective_date
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
       attr_reader :metadata
       # Integer representing the number of trial period days before the customer is charged for the first time.
       attr_reader :trial_period_days
@@ -349,15 +349,15 @@ module Stripe
       end
     end
 
-    class TotalDetails < Stripe::StripeObject
-      class Breakdown < Stripe::StripeObject
-        class Discount < Stripe::StripeObject
+    class TotalDetails < ::Stripe::StripeObject
+      class Breakdown < ::Stripe::StripeObject
+        class Discount < ::Stripe::StripeObject
           # The amount discounted.
           attr_reader :amount
-          # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+          # A discount represents the actual application of a [coupon](https://api.stripe.com#coupons) or [promotion code](https://api.stripe.com#promotion_codes).
           # It contains information about when the discount began, when it will end, and what it is applied to.
           #
-          # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
+          # Related guide: [Applying discounts to subscriptions](https://docs.stripe.com/billing/subscriptions/discounts)
           attr_reader :discount
 
           def self.inner_class_types
@@ -369,7 +369,7 @@ module Stripe
           end
         end
 
-        class Tax < Stripe::StripeObject
+        class Tax < ::Stripe::StripeObject
           # Amount of tax applied for this rate.
           attr_reader :amount
           # Tax rates can be applied to [invoices](/invoicing/taxes/tax-rates), [subscriptions](/billing/taxes/tax-rates) and [Checkout Sessions](/payments/checkout/use-manual-tax-rates) to collect tax.
@@ -420,7 +420,7 @@ module Stripe
       end
     end
 
-    class TransferData < Stripe::StripeObject
+    class TransferData < ::Stripe::StripeObject
       # The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.
       attr_reader :amount
       # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.
@@ -456,8 +456,10 @@ module Stripe
     attr_reader :created
     # 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).
     attr_reader :currency
-    # The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
+    # The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
     attr_reader :customer
+    # The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it.
+    attr_reader :customer_account
     # The tax rates applied to this quote.
     attr_reader :default_tax_rates
     # A description that will be displayed on the quote PDF.
@@ -468,7 +470,7 @@ module Stripe
     attr_reader :expires_at
     # A footer that will be displayed on the quote PDF.
     attr_reader :footer
-    # Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details.
+    # Details of the quote that was cloned. See the [cloning documentation](https://docs.stripe.com/quotes/clone) for more details.
     attr_reader :from_quote
     # A header that will be displayed on the quote PDF.
     attr_reader :header
@@ -480,11 +482,11 @@ module Stripe
     attr_reader :invoice_settings
     # A list of items the customer is being quoted for.
     attr_reader :line_items
-    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     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 unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize).
+    # A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://docs.stripe.com/quotes/overview#finalize).
     attr_reader :number
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object

data/lib/stripe/resources/radar/early_fraud_warning.rb

@@ -6,7 +6,7 @@ module Stripe
     # An early fraud warning indicates that the card issuer has notified us that a
     # charge may be fraudulent.
     #
-    # Related guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)
+    # Related guide: [Early fraud warnings](https://docs.stripe.com/disputes/measuring#early-fraud-warnings)
     class EarlyFraudWarning < APIResource
       extend Stripe::APIOperations::List
 
@@ -25,7 +25,7 @@ module Stripe
       attr_reader :fraud_type
       # Unique identifier for the object.
       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.
+      # If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
       attr_reader :livemode
       # String representing the object's type. Objects of the same type share the same value.
       attr_reader :object