stripe 15.1.0 → 15.2.0

data/lib/stripe/services/invoice_service.rb

@@ -10,8 +10,7 @@ module Stripe
       @line_items = Stripe::InvoiceLineItemService.new(@requestor)
     end
 
-    class DeleteParams < Stripe::RequestParams
-    end
+    class DeleteParams < Stripe::RequestParams; end
 
     class RetrieveParams < Stripe::RequestParams
       # Specifies which fields in the response should be expanded.
@@ -188,11 +187,8 @@ module Stripe
             end
           end
 
-          class Konbini < Stripe::RequestParams
-          end
-
-          class SepaDebit < Stripe::RequestParams
-          end
+          class Konbini < Stripe::RequestParams; end
+          class SepaDebit < Stripe::RequestParams; end
 
           class UsBankAccount < Stripe::RequestParams
             class FinancialConnections < Stripe::RequestParams
@@ -838,11 +834,8 @@ module Stripe
             end
           end
 
-          class Konbini < Stripe::RequestParams
-          end
-
-          class SepaDebit < Stripe::RequestParams
-          end
+          class Konbini < Stripe::RequestParams; end
+          class SepaDebit < Stripe::RequestParams; end
 
           class UsBankAccount < Stripe::RequestParams
             class FinancialConnections < Stripe::RequestParams
@@ -1488,6 +1481,18 @@ module Stripe
       end
     end
 
+    class AttachPaymentParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The ID of the PaymentIntent to attach to the invoice.
+      attr_accessor :payment_intent
+
+      def initialize(expand: nil, payment_intent: nil)
+        @expand = expand
+        @payment_intent = payment_intent
+      end
+    end
+
     class FinalizeInvoiceParams < Stripe::RequestParams
       # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
       attr_accessor :auto_advance
@@ -2197,6 +2202,18 @@ module Stripe
             end
           end
 
+          class BillingThresholds < Stripe::RequestParams
+            # Monetary threshold that triggers the subscription to advance to a new billing period
+            attr_accessor :amount_gte
+            # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
+            attr_accessor :reset_billing_cycle_anchor
+
+            def initialize(amount_gte: nil, reset_billing_cycle_anchor: nil)
+              @amount_gte = amount_gte
+              @reset_billing_cycle_anchor = reset_billing_cycle_anchor
+            end
+          end
+
           class Discount < Stripe::RequestParams
             # ID of the coupon to create a new discount for.
             attr_accessor :coupon
@@ -2239,6 +2256,15 @@ module Stripe
           end
 
           class Item < Stripe::RequestParams
+            class BillingThresholds < Stripe::RequestParams
+              # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
+              attr_accessor :usage_gte
+
+              def initialize(usage_gte: nil)
+                @usage_gte = usage_gte
+              end
+            end
+
             class Discount < Stripe::RequestParams
               # ID of the coupon to create a new discount for.
               attr_accessor :coupon
@@ -2295,6 +2321,8 @@ module Stripe
                 @unit_amount_decimal = unit_amount_decimal
               end
             end
+            # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
+            attr_accessor :billing_thresholds
             # The coupons to redeem into discounts for the subscription item.
             attr_accessor :discounts
             # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
@@ -2311,6 +2339,7 @@ module Stripe
             attr_accessor :tax_rates
 
             def initialize(
+              billing_thresholds: nil,
               discounts: nil,
               metadata: nil,
               plan: nil,
@@ -2319,6 +2348,7 @@ module Stripe
               quantity: nil,
               tax_rates: nil
             )
+              @billing_thresholds = billing_thresholds
               @discounts = discounts
               @metadata = metadata
               @plan = plan
@@ -2348,6 +2378,8 @@ module Stripe
           attr_accessor :automatic_tax
           # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
           attr_accessor :billing_cycle_anchor
+          # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
+          attr_accessor :billing_thresholds
           # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically` on creation.
           attr_accessor :collection_method
           # 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).
@@ -2372,7 +2404,7 @@ module Stripe
           attr_accessor :metadata
           # The account on behalf of which to charge, for each of the associated subscription's invoices.
           attr_accessor :on_behalf_of
-          # Whether the subscription schedule will create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase. The default value is `create_prorations`. This setting controls prorations when a phase is started asynchronously and it is persisted as a field on the phase. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration of the current phase.
+          # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://stripe.com/docs/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
           attr_accessor :proration_behavior
           # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
           attr_accessor :start_date
@@ -2388,6 +2420,7 @@ module Stripe
             application_fee_percent: nil,
             automatic_tax: nil,
             billing_cycle_anchor: nil,
+            billing_thresholds: nil,
             collection_method: nil,
             currency: nil,
             default_payment_method: nil,
@@ -2410,6 +2443,7 @@ module Stripe
             @application_fee_percent = application_fee_percent
             @automatic_tax = automatic_tax
             @billing_cycle_anchor = billing_cycle_anchor
+            @billing_thresholds = billing_thresholds
             @collection_method = collection_method
             @currency = currency
             @default_payment_method = default_payment_method
@@ -2445,6 +2479,15 @@ module Stripe
 
       class SubscriptionDetails < Stripe::RequestParams
         class Item < Stripe::RequestParams
+          class BillingThresholds < Stripe::RequestParams
+            # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
+            attr_accessor :usage_gte
+
+            def initialize(usage_gte: nil)
+              @usage_gte = usage_gte
+            end
+          end
+
           class Discount < Stripe::RequestParams
             # ID of the coupon to create a new discount for.
             attr_accessor :coupon
@@ -2501,6 +2544,8 @@ module Stripe
               @unit_amount_decimal = unit_amount_decimal
             end
           end
+          # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
+          attr_accessor :billing_thresholds
           # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
           attr_accessor :clear_usage
           # A flag that, if set to `true`, will delete the specified item.
@@ -2523,6 +2568,7 @@ module Stripe
           attr_accessor :tax_rates
 
           def initialize(
+            billing_thresholds: nil,
             clear_usage: nil,
             deleted: nil,
             discounts: nil,
@@ -2534,6 +2580,7 @@ module Stripe
             quantity: nil,
             tax_rates: nil
           )
+            @billing_thresholds = billing_thresholds
             @clear_usage = clear_usage
             @deleted = deleted
             @discounts = discounts
@@ -2550,7 +2597,7 @@ module Stripe
         attr_accessor :billing_cycle_anchor
         # A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
         attr_accessor :cancel_at
-        # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
+        # Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`. This param will be removed in a future API version. Please use `cancel_at` instead.
         attr_accessor :cancel_at_period_end
         # This simulates the subscription being canceled or expired immediately.
         attr_accessor :cancel_now
@@ -2668,16 +2715,38 @@ module Stripe
       )
     end
 
-    # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://stripe.com/docs/api#finalize_invoice) the invoice to your customers.
+    # Attaches a PaymentIntent or an Out of Band Payment to the invoice, adding it to the list of payments.
+    #
+    # For the PaymentIntent, when the PaymentIntent's status changes to succeeded, the payment is credited
+    # to the invoice, increasing its amount_paid. When the invoice is fully paid, the
+    # invoice's status becomes paid.
+    #
+    # If the PaymentIntent's status is already succeeded when it's attached, it's
+    # credited to the invoice immediately.
+    #
+    # See: [Partial payments](https://docs.stripe.com/docs/invoicing/partial-payments) to learn more.
+    def attach_payment(invoice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/invoices/%<invoice>s/attach_payment", { invoice: CGI.escape(invoice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # This endpoint creates a draft invoice for a given customer. The invoice remains a draft until you [finalize the invoice, which allows you to [pay](#pay_invoice) or <a href="#send_invoice">send](https://docs.stripe.com/api#finalize_invoice) the invoice to your customers.
     def create(params = {}, opts = {})
       request(method: :post, path: "/v1/invoices", params: params, opts: opts, base_address: :api)
     end
 
     # At any time, you can preview the upcoming invoice for a subscription or subscription schedule. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.
     #
-    # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
+    # You can also preview the effects of creating or updating a subscription or subscription schedule, including a preview of any prorations that will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update.
     #
-    # You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.
+    # The recommended way to get only the prorations being previewed on the invoice is to consider line items where parent.subscription_item_details.proration is true.
+    #
+    # Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer's discount.
     #
     # Note: Currency conversion calculations use the latest exchange rates. Exchange rates may vary between the time of the preview and the time of the actual invoice creation. [Learn more](https://docs.stripe.com/currencies/conversions)
     def create_preview(params = {}, opts = {})
@@ -2690,7 +2759,7 @@ module Stripe
       )
     end
 
-    # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://stripe.com/docs/api#void_invoice).
+    # Permanently deletes a one-off invoice draft. This cannot be undone. Attempts to delete invoices that are no longer in a draft state will fail; once an invoice has been finalized or if an invoice is for a subscription, it must be [voided](https://docs.stripe.com/api#void_invoice).
     def delete(invoice, params = {}, opts = {})
       request(
         method: :delete,
@@ -2761,7 +2830,7 @@ module Stripe
       )
     end
 
-    # Search for invoices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+    # Search for invoices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
     # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
     # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
     # to an hour behind during outages. Search functionality is not available to merchants in India.
@@ -2788,11 +2857,11 @@ module Stripe
       )
     end
 
-    # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
+    # Draft invoices are fully editable. Once an invoice is [finalized](https://docs.stripe.com/docs/billing/invoices/workflow#finalized),
     # monetary values, as well as collection_method, become uneditable.
     #
     # If you would like to stop the Stripe Billing engine from automatically finalizing, reattempting payments on,
-    # sending reminders for, or [automatically reconciling](https://stripe.com/docs/billing/invoices/reconciliation) invoices, pass
+    # sending reminders for, or [automatically reconciling](https://docs.stripe.com/docs/billing/invoices/reconciliation) invoices, pass
     # auto_advance=false.
     def update(invoice, params = {}, opts = {})
       request(
@@ -2815,9 +2884,9 @@ module Stripe
       )
     end
 
-    # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://stripe.com/docs/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
+    # Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to [deletion](https://docs.stripe.com/api#delete_invoice), however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.
     #
-    # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://stripe.com/docs/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
+    # Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you're doing business in. You might need to [issue another invoice or <a href="#create_credit_note">credit note](https://docs.stripe.com/api#create_invoice) instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.
     def void_invoice(invoice, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/issuing/authorization_service.rb

@@ -108,8 +108,8 @@ module Stripe
         end
       end
 
-      # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
-      # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
+      # [Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the [real-time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
+      # This method is deprecated. Instead, [respond directly to the webhook request to approve an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
       def approve(authorization, params = {}, opts = {})
         request(
           method: :post,
@@ -120,8 +120,8 @@ module Stripe
         )
       end
 
-      # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations) flow.
-      # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
+      # [Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the [real time authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations) flow.
+      # This method is deprecated. Instead, [respond directly to the webhook request to decline an authorization](https://docs.stripe.com/docs/issuing/controls/real-time-authorizations#authorization-handling).
       def decline(authorization, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/issuing/card_service.rb

@@ -219,7 +219,7 @@ module Stripe
         attr_accessor :currency
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-        # Attribute for param field financial_account
+        # The new financial account ID the card will be associated with. This field allows a card to be reassigned to a different financial account.
         attr_accessor :financial_account
         # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata

data/lib/stripe/services/issuing/dispute_service.rb

@@ -637,7 +637,7 @@ module Stripe
         end
       end
 
-      # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
+      # Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.
       def create(params = {}, opts = {})
         request(
           method: :post,
@@ -670,7 +670,7 @@ module Stripe
         )
       end
 
-      # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
+      # Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://docs.stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).
       def submit(dispute, params = {}, opts = {})
         request(
           method: :post,