Support for APIs in the new API version 2025-03-31.basil (#1543)

* Update generated code for v1559

* Update generated code for v1566

* Update generated code for v1572

* Update generated code for v1618

* Update generated code for v1635

---------

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
Co-authored-by: prathmesh-stripe <[email protected]>
Co-authored-by: helenye-stripe <[email protected]>

Author: 3 people

OPENAPI_VERSION

@@ -1 +1 @@
-v1505
+v1635

lib/stripe/api_version.rb

@@ -3,6 +3,6 @@
 
 module Stripe
   module ApiVersion
-    CURRENT = "2025-02-24.acacia"
+    CURRENT = "2025-03-31.basil"
   end
 end

lib/stripe/object_types.rb

@@ -70,6 +70,7 @@ def self.object_names_to_classes
         Invoice.object_name => Invoice,
         InvoiceItem.object_name => InvoiceItem,
         InvoiceLineItem.object_name => InvoiceLineItem,
+        InvoicePayment.object_name => InvoicePayment,
         InvoiceRenderingTemplate.object_name => InvoiceRenderingTemplate,
         Issuing::Authorization.object_name => Issuing::Authorization,
         Issuing::Card.object_name => Issuing::Card,
@@ -140,8 +141,6 @@ def self.object_names_to_classes
         Treasury::ReceivedDebit.object_name => Treasury::ReceivedDebit,
         Treasury::Transaction.object_name => Treasury::Transaction,
         Treasury::TransactionEntry.object_name => Treasury::TransactionEntry,
-        UsageRecord.object_name => UsageRecord,
-        UsageRecordSummary.object_name => UsageRecordSummary,
         WebhookEndpoint.object_name => WebhookEndpoint,
         # object classes: The end of the section generated from our OpenAPI spec
       }

lib/stripe/resources.rb

@@ -59,6 +59,7 @@
 require "stripe/resources/invoice"
 require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
+require "stripe/resources/invoice_payment"
 require "stripe/resources/invoice_rendering_template"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
@@ -129,8 +130,6 @@
 require "stripe/resources/treasury/received_debit"
 require "stripe/resources/treasury/transaction"
 require "stripe/resources/treasury/transaction_entry"
-require "stripe/resources/usage_record"
-require "stripe/resources/usage_record_summary"
 require "stripe/resources/v2/billing/meter_event"
 require "stripe/resources/v2/billing/meter_event_adjustment"
 require "stripe/resources/v2/billing/meter_event_session"

lib/stripe/resources/checkout/session.rb

@@ -27,7 +27,7 @@ def self.object_name
         "checkout.session"
       end
 
-      # Creates a Session object.
+      # Creates a Checkout Session object.
       def self.create(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -37,9 +37,9 @@ def self.create(params = {}, opts = {})
         )
       end
 
-      # A Session can be expired when it is in one of these statuses: open
+      # A Checkout Session can be expired when it is in one of these statuses: open
       #
-      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+      # After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
       def expire(params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -49,9 +49,9 @@ def expire(params = {}, opts = {})
         )
       end
 
-      # A Session can be expired when it is in one of these statuses: open
+      # A Checkout Session can be expired when it is in one of these statuses: open
       #
-      # After it expires, a customer can't complete a Session and customers loading the Session see a message saying the Session is expired.
+      # After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
       def self.expire(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,
@@ -91,7 +91,7 @@ def self.list_line_items(session, params = {}, opts = {})
         )
       end
 
-      # Updates a Session object.
+      # Updates a Checkout Session object.
       def self.update(session, params = {}, opts = {})
         request_stripe_object(
           method: :post,

lib/stripe/resources/invoice.rb

@@ -135,16 +135,6 @@ def self.list(params = {}, opts = {})
       request_stripe_object(method: :get, path: "/v1/invoices", params: params, opts: opts)
     end
 
-    # When retrieving an upcoming invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
-    def self.list_upcoming_line_items(params = {}, opts = {})
-      request_stripe_object(
-        method: :get,
-        path: "/v1/invoices/upcoming/lines",
-        params: params,
-        opts: opts
-      )
-    end
-
     # Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
     def mark_uncollectible(params = {}, opts = {})
       request_stripe_object(
@@ -237,17 +227,6 @@ def self.send_invoice(invoice, params = {}, opts = {})
       )
     end
 
-    # At any time, you can preview the upcoming invoice for a customer. 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 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.
-    #
-    # 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 self.upcoming(params = {}, opts = {})
-      request_stripe_object(method: :get, path: "/v1/invoices/upcoming", params: params, opts: opts)
-    end
-
     # Draft invoices are fully editable. Once an invoice is [finalized](https://stripe.com/docs/billing/invoices/workflow#finalized),
     # monetary values, as well as collection_method, become uneditable.
     #

lib/stripe/resources/invoice_payment.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # The invoice payment object
+  class InvoicePayment < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "invoice_payment"
+    def self.object_name
+      "invoice_payment"
+    end
+
+    # When retrieving an invoice, there is an includable payments property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of payments.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/invoice_payments", params: params, opts: opts)
+    end
+  end
+end

lib/stripe/resources/payment_method_domain.rb

@@ -46,10 +46,10 @@ def self.update(payment_method_domain, params = {}, opts = {})
       )
     end
 
-    # Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
-    # The payment method doesn't appear in Elements for this domain until it is active.
+    # Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
+    # The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
     #
-    # To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+    # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
     #
     # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
     def validate(params = {}, opts = {})
@@ -61,10 +61,10 @@ def validate(params = {}, opts = {})
       )
     end
 
-    # Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
-    # The payment method doesn't appear in Elements for this domain until it is active.
+    # Some payment methods might require additional steps to register a domain. If the requirements weren't satisfied when the domain was created, the payment method will be inactive on the domain.
+    # The payment method doesn't appear in Elements or Embedded Checkout for this domain until it is active.
     #
-    # To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+    # To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
     #
     # Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
     def self.validate(payment_method_domain, params = {}, opts = {})

lib/stripe/resources/person.rb

@@ -4,7 +4,7 @@
 module Stripe
   # This is an object representing a person associated with a Stripe account.
   #
-  # A platform cannot access a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
+  # A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
   #
   # See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
   class Person < APIResource

lib/stripe/resources/price.rb

@@ -19,7 +19,7 @@ def self.object_name
       "price"
     end
 
-    # Creates a new price for an existing product. The price can be recurring or one-time.
+    # Creates a new [Price for an existing <a href="https://docs.stripe.com/api/products">Product](https://docs.stripe.com/api/prices). The Price can be recurring or one-time.
     def self.create(params = {}, opts = {})
       request_stripe_object(method: :post, path: "/v1/prices", params: params, opts: opts)
     end