RubyGems - stripe - Versions diffs - 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1 - Mend

stripe 18.1.0.pre.beta.1 → 18.2.0.pre.alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (721) hide show

data/lib/stripe/resources/confirmation_token.rb CHANGED Viewed

@@ -7,8 +7,8 @@ module Stripe
   # is successful, values present on the ConfirmationToken are written onto the Intent.
   #
   # To learn more about how to use ConfirmationToken, visit the related guides:
-  # - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)
-  # - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation).
+  # - [Finalize payments on the server](https://docs.stripe.com/payments/finalize-payments-on-the-server)
+  # - [Build two-step confirmation](https://docs.stripe.com/payments/build-a-two-step-confirmation).
   class ConfirmationToken < APIResource
     OBJECT_NAME = "confirmation_token"
     def self.object_name
@@ -252,7 +252,7 @@ module Stripe
           attr_reader :line2
           # ZIP or postal code.
           attr_reader :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_reader :state
           def self.inner_class_types
@@ -307,6 +307,21 @@ module Stripe
       end
       class Card < ::Stripe::StripeObject
+        class Benefits < ::Stripe::StripeObject
+          # Issuer of this benefit card
+          attr_reader :issuer
+          # Available benefit programs for this card
+          attr_reader :programs
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
         class Checks < ::Stripe::StripeObject
           # If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.
           attr_reader :address_line1_check
@@ -413,7 +428,7 @@ module Stripe
               attr_reader :generated_card
               # Issuer identification number of the card. (For internal use only and not typically available in standard API requests.)
               attr_reader :iin
-              # Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
+              # Whether this [PaymentIntent](https://docs.stripe.com/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://docs.stripe.com/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support).
               attr_reader :incremental_authorization_supported
               # The name of the card's issuing bank. (For internal use only and not typically available in standard API requests.)
               attr_reader :issuer
@@ -554,7 +569,7 @@ module Stripe
               attr_reader :line2
               # ZIP or postal code.
               attr_reader :postal_code
-              # State, county, province, or region.
+              # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
               attr_reader :state
               def self.inner_class_types
@@ -577,7 +592,7 @@ module Stripe
               attr_reader :line2
               # ZIP or postal code.
               attr_reader :postal_code
-              # State, county, province, or region.
+              # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
               attr_reader :state
               def self.inner_class_types
@@ -631,7 +646,7 @@ module Stripe
               attr_reader :line2
               # ZIP or postal code.
               attr_reader :postal_code
-              # State, county, province, or region.
+              # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
               attr_reader :state
               def self.inner_class_types
@@ -654,7 +669,7 @@ module Stripe
               attr_reader :line2
               # ZIP or postal code.
               attr_reader :postal_code
-              # State, county, province, or region.
+              # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
               attr_reader :state
               def self.inner_class_types
@@ -720,6 +735,8 @@ module Stripe
             @field_remappings = {}
           end
         end
+        # Attribute for field benefits
+        attr_reader :benefits
         # Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.
         attr_reader :brand
         # Checks on Card address and CVC if provided.
@@ -759,6 +776,7 @@ module Stripe
         def self.inner_class_types
           @inner_class_types = {
+            benefits: Benefits,
             checks: Checks,
             generated_from: GeneratedFrom,
             networks: Networks,
@@ -974,7 +992,7 @@ module Stripe
       end
       class Ideal < ::Stripe::StripeObject
-        # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+        # The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `buut`, `finom`, `handelsbanken`, `ing`, `knab`, `mollie`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
         attr_reader :bank
         # The Bank Identifier Code of the customer's bank, if the bank was provided.
         attr_reader :bic
@@ -1779,7 +1797,7 @@ module Stripe
         attr_reader :line2
         # ZIP or postal code.
         attr_reader :postal_code
-        # State, county, province, or region.
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
         attr_reader :state
         def self.inner_class_types
@@ -1827,7 +1845,7 @@ module Stripe
     attr_reader :return_url
     # Indicates that you intend to make future payments with this ConfirmationToken's payment method.
     #
-    # The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
+    # The presence of this property will [attach the payment method](https://docs.stripe.com/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
     attr_reader :setup_future_usage
     # ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
     attr_reader :setup_intent

data/lib/stripe/resources/coupon.rb CHANGED Viewed

@@ -3,8 +3,8 @@
 module Stripe
   # 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).
+  # might want to apply to a customer. Coupons may be applied to [subscriptions](https://api.stripe.com#subscriptions), [invoices](https://api.stripe.com#invoices),
+  # [checkout sessions](https://docs.stripe.com/api/checkout/sessions), [quotes](https://api.stripe.com#quotes), and more. Coupons do not work with conventional one-off [charges](https://api.stripe.com#create_charge) or [payment intents](https://docs.stripe.com/api/payment_intents).
   class Coupon < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -78,7 +78,7 @@ module Stripe
     attr_reader :livemode
     # Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid.
     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
     # Name of the coupon displayed to customers on for instance invoices or receipts.
     attr_reader :name

data/lib/stripe/resources/credit_note.rb CHANGED Viewed

@@ -4,7 +4,7 @@
 module Stripe
   # 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)
+  # Related guide: [Credit notes](https://docs.stripe.com/billing/invoices/credit-notes)
   class CreditNote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -125,7 +125,7 @@ module Stripe
     class TotalTax < ::Stripe::StripeObject
       class TaxRateDetails < ::Stripe::StripeObject
-        # Attribute for field tax_rate
+        # ID of the tax rate
         attr_reader :tax_rate
         def self.inner_class_types
@@ -167,7 +167,7 @@ module Stripe
     attr_reader :currency
     # ID of the customer.
     attr_reader :customer
-    # ID of the account.
+    # ID of the account representing the customer.
     attr_reader :customer_account
     # Customer balance transaction related to this credit note.
     attr_reader :customer_balance_transaction
@@ -187,7 +187,7 @@ module Stripe
     attr_reader :livemode
     # Customer-facing text that appears on the credit note PDF.
     attr_reader :memo
-    # 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 credit note and appears on the PDF of the credit note and its associated invoice.
     attr_reader :number
@@ -209,7 +209,7 @@ module Stripe
     attr_reader :refunds
     # The details of the cost of shipping, including the ShippingRate applied to the invoice.
     attr_reader :shipping_cost
-    # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding).
+    # Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://docs.stripe.com/billing/invoices/credit-notes#voiding).
     attr_reader :status
     # The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.
     attr_reader :subtotal

data/lib/stripe/resources/credit_note_line_item.rb CHANGED Viewed

@@ -60,7 +60,7 @@ module Stripe
     class Tax < ::Stripe::StripeObject
       class TaxRateDetails < ::Stripe::StripeObject
-        # Attribute for field tax_rate
+        # ID of the tax rate
         attr_reader :tax_rate
         def self.inner_class_types

data/lib/stripe/resources/customer.rb CHANGED Viewed

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 module Stripe
-  # This object represents a customer of your business. Use it to [create recurring charges](https://stripe.com/docs/invoicing/customer), [save payment](https://stripe.com/docs/payments/save-during-payment) and contact information,
+  # This object represents a customer of your business. Use it to [create recurring charges](https://docs.stripe.com/invoicing/customer), [save payment](https://docs.stripe.com/payments/save-during-payment) and contact information,
   # and track payments that belong to the same customer.
   class Customer < APIResource
     extend Stripe::APIOperations::Create
@@ -33,7 +33,7 @@ module Stripe
       attr_reader :line2
       # ZIP or postal code.
       attr_reader :postal_code
-      # State, county, province, or region.
+      # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
       attr_reader :state
       def self.inner_class_types
@@ -105,7 +105,7 @@ module Stripe
         attr_reader :line2
         # ZIP or postal code.
         attr_reader :postal_code
-        # State, county, province, or region.
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
         attr_reader :state
         def self.inner_class_types
@@ -172,7 +172,7 @@ module Stripe
     end
     # The customer's address.
     attr_reader :address
-    # The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://stripe.com/docs/api/customers/object#customer_object-invoice_credit_balance).
+    # The current balance, if any, that's stored on the customer in their default currency. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize. For multi-currency balances, see [invoice_credit_balance](https://docs.stripe.com/api/customers/object#customer_object-invoice_credit_balance).
     attr_reader :balance
     # The customer's business name.
     attr_reader :business_name
@@ -182,15 +182,15 @@ module Stripe
     attr_reader :created
     # Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.
     attr_reader :currency
-    # Attribute for field customer_account
+    # The ID of an Account representing a customer. You can use this ID with any v1 API that accepts a customer_account parameter.
     attr_reader :customer_account
     # ID of the default payment source for the customer.
     #
-    # If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
+    # If you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://docs.stripe.com/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.
     attr_reader :default_source
     # Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.
     #
-    # If an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.
+    # If an invoice becomes uncollectible by [dunning](https://docs.stripe.com/billing/automatic-collection), `delinquent` doesn't reset to `false`.
     #
     # If you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.
     attr_reader :delinquent
@@ -212,7 +212,7 @@ module Stripe
     attr_reader :invoice_settings
     # 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
     # The customer's full name or business name.
     attr_reader :name

data/lib/stripe/resources/customer_balance_transaction.rb CHANGED Viewed

@@ -2,12 +2,12 @@
 # frozen_string_literal: true
 module Stripe
-  # Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
+  # 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://stripe.com/docs/api/customers/update),
+  # 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://stripe.com/docs/billing/customer/balance)
+  # Related guide: [Customer balance](https://docs.stripe.com/billing/customer/balance)
   class CustomerBalanceTransaction < APIResource
     include Stripe::APIOperations::Save
@@ -28,7 +28,7 @@ module Stripe
     attr_reader :currency
     # The ID of the customer the transaction belongs to.
     attr_reader :customer
-    # Attribute for field customer_account
+    # The ID of an Account representing a customer that the transaction belongs to.
     attr_reader :customer_account
     # An arbitrary string attached to the object. Often useful for displaying to users.
     attr_reader :description
@@ -40,11 +40,11 @@ module Stripe
     attr_reader :invoice
     # 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
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
-    # 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://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.
+    # 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.
     attr_reader :type
     def resource_url

data/lib/stripe/resources/customer_cash_balance_transaction.rb CHANGED Viewed

@@ -13,9 +13,9 @@ module Stripe
     end
     class AdjustedForOverdraft < ::Stripe::StripeObject
-      # The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
+      # The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
       attr_reader :balance_transaction
-      # The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
+      # The [Cash Balance Transaction](https://docs.stripe.com/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
       attr_reader :linked_transaction
       def self.inner_class_types
@@ -28,7 +28,7 @@ module Stripe
     end
     class AppliedToPayment < ::Stripe::StripeObject
-      # The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.
+      # The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were applied to.
       attr_reader :payment_intent
       def self.inner_class_types
@@ -146,7 +146,7 @@ module Stripe
     end
     class RefundedFromPayment < ::Stripe::StripeObject
-      # The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.
+      # The [Refund](https://docs.stripe.com/api/refunds/object) that moved these funds into the customer's cash balance.
       attr_reader :refund
       def self.inner_class_types
@@ -159,7 +159,7 @@ module Stripe
     end
     class TransferredToBalance < ::Stripe::StripeObject
-      # The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
+      # The [Balance Transaction](https://docs.stripe.com/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance.
       attr_reader :balance_transaction
       def self.inner_class_types
@@ -172,7 +172,7 @@ module Stripe
     end
     class UnappliedFromPayment < ::Stripe::StripeObject
-      # The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.
+      # The [Payment Intent](https://docs.stripe.com/api/payment_intents/object) that funds were unapplied from.
       attr_reader :payment_intent
       def self.inner_class_types
@@ -193,9 +193,9 @@ module Stripe
     attr_reader :currency
     # The customer whose available cash balance changed as a result of this transaction.
     attr_reader :customer
-    # Attribute for field customer_account
+    # The ID of an Account representing a customer whose available cash balance changed as a result of this transaction.
     attr_reader :customer_account
-    # The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+    # 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).
     attr_reader :ending_balance
     # Attribute for field funded
     attr_reader :funded
@@ -203,7 +203,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
-    # The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/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.
+    # 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.
     attr_reader :net_amount
     # String representing the object's type. Objects of the same type share the same value.
     attr_reader :object
@@ -211,7 +211,7 @@ module Stripe
     attr_reader :refunded_from_payment
     # Attribute for field transferred_to_balance
     attr_reader :transferred_to_balance
-    # The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types.
+    # 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.
     attr_reader :type
     # Attribute for field unapplied_from_payment
     attr_reader :unapplied_from_payment