stripe 7.1.0 → 7.2.0.pre.beta.1

data/lib/stripe/resources/invoice.rb

@@ -2,6 +2,38 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Invoices are statements of amounts owed by a customer, and are either
+  # generated one-off, or generated periodically from a subscription.
+  #
+  # They contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments
+  # that may be caused by subscription upgrades/downgrades (if necessary).
+  #
+  # If your invoice is configured to be billed through automatic charges,
+  # Stripe automatically finalizes your invoice and attempts payment. Note
+  # that finalizing the invoice,
+  # [when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does
+  # not happen immediately as the invoice is created. Stripe waits
+  # until one hour after the last webhook was successfully sent (or the last
+  # webhook timed out after failing). If you (and the platforms you may have
+  # connected to) have no webhooks configured, Stripe waits one hour after
+  # creation to finalize the invoice.
+  #
+  # If your invoice is configured to be billed by sending an email, then based on your
+  # [email settings](https://dashboard.stripe.com/account/billing/automatic),
+  # Stripe will email the invoice to your customer and await payment. These
+  # emails can contain a link to a hosted page to pay the invoice.
+  #
+  # Stripe applies any customer credit on the account before determining the
+  # amount due for the invoice (i.e., the amount that will be actually
+  # charged). If the amount due for the invoice is less than Stripe's [minimum allowed charge
+  # per currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts), the
+  # invoice is automatically marked paid, and we add the amount due to the
+  # customer's credit balance which is applied to the next invoice.
+  #
+  # More details on the customer's credit balance are
+  # [here](https://stripe.com/docs/billing/customer/balance).
+  #
+  # Related guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).
   class Invoice < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/invoice_item.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Sometimes you want to add a charge or credit to a customer, but actually
+  # charge or credit the customer's card only at the end of a regular billing
+  # cycle. This is useful for combining several charges (to minimize
+  # per-transaction fees), or for having Stripe tabulate your usage-based billing
+  # totals.
+  #
+  # Related guide: [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).
   class InvoiceItem < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/issuing/authorization.rb

@@ -3,6 +3,11 @@
 
 module Stripe
   module Issuing
+    # When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`
+    # object is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the
+    # purchase to be completed successfully.
+    #
+    # Related guide: [Issued Card Authorizations](https://stripe.com/docs/issuing/purchases/authorizations).
     class Authorization < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save

data/lib/stripe/resources/issuing/card.rb

@@ -3,6 +3,7 @@
 
 module Stripe
   module Issuing
+    # You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders.
     class Card < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/issuing/cardholder.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Issuing
+    # An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.
+    #
+    # Related guide: [How to create a Cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)
     class Cardholder < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/issuing/dispute.rb

@@ -3,6 +3,9 @@
 
 module Stripe
   module Issuing
+    # As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.
+    #
+    # Related guide: [Disputing Transactions](https://stripe.com/docs/issuing/purchases/disputes)
     class Dispute < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/issuing/transaction.rb

@@ -3,6 +3,11 @@
 
 module Stripe
   module Issuing
+    # Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving
+    # your Stripe account, such as a completed purchase or refund, is represented by an Issuing
+    # `Transaction` object.
+    #
+    # Related guide: [Issued Card Transactions](https://stripe.com/docs/issuing/purchases/transactions).
     class Transaction < APIResource
       extend Stripe::APIOperations::List
       include Stripe::APIOperations::Save

data/lib/stripe/resources/line_item.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A line item.
   class LineItem < APIResource
     OBJECT_NAME = "item"
   end

data/lib/stripe/resources/mandate.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Mandate is a record of the permission a customer has given you to debit their payment method.
   class Mandate < APIResource
     OBJECT_NAME = "mandate"
   end

data/lib/stripe/resources/order.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # An Order describes a purchase being made by a customer, including the
+  # products & quantities being purchased, the order status, the payment information,
+  # and the billing/shipping details.
+  #
+  # Related guide: [Orders overview](https://stripe.com/docs/orders)
   class Order < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payment_intent.rb

@@ -2,6 +2,17 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A PaymentIntent guides you through the process of collecting a payment from your customer.
+  # We recommend that you create exactly one PaymentIntent for each order or
+  # customer session in your system. You can reference the PaymentIntent later to
+  # see the history of payment attempts for a particular session.
+  #
+  # A PaymentIntent transitions through
+  # [multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)
+  # throughout its lifetime as it interfaces with Stripe.js to perform
+  # authentication flows and ultimately creates at most one successful charge.
+  #
+  # Related guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents).
   class PaymentIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payment_link.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.
+  #
+  # When a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.
+  #
+  # Related guide: [Payment Links API](https://stripe.com/docs/payments/payment-links/api)
   class PaymentLink < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payment_method.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # PaymentMethod objects represent your customer's payment instruments.
+  # You can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to
+  # Customer objects to store instrument details for future payments.
+  #
+  # Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).
   class PaymentMethod < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/payout.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A `Payout` object is created when you receive funds from Stripe, or when you
+  # initiate a payout to either a bank account or debit card of a [connected
+  # Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+  # as well as list all payouts. Payouts are made on [varying
+  # schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
+  # industry.
+  #
+  # Related guide: [Receiving Payouts](https://stripe.com/docs/payouts).
   class Payout < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/person.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # This is an object representing a person associated with a Stripe account.
+  #
+  # A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
+  # See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.
+  #
+  # Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
   class Person < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/plan.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+  #
+  # Plans define the base price, currency, and billing cycle for recurring purchases of products.
+  # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.
+  #
+  # For example, you might have a single "gold" product that has plans for $10/month, $100/year, €9/month, and €90/year.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).
   class Plan < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/price.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.
+  # [Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.
+  #
+  # For example, you might have a single "gold" product that has prices for $10/month, $100/year, and €9 once.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).
   class Price < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/product.rb

@@ -2,6 +2,14 @@
 # frozen_string_literal: true
 
 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.
+  #
+  # Related guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),
+  # [share a Payment Link](https://stripe.com/docs/payments/payment-links/overview),
+  # [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)
   class Product < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/promotion_code.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
+  # create multiple codes for a single coupon.
   class PromotionCode < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/quote.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A Quote is a way to model prices that you'd like to provide to a customer.
+  # Once accepted, it will automatically create an invoice, subscription or subscription schedule.
   class Quote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/quote_phase.rb

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  # A quote phase describes the line items, coupons, and trialing status of a subscription for a predefined time period.
+  class QuotePhase < APIResource
+    extend Stripe::APIOperations::List
+
+    OBJECT_NAME = "quote_phase"
+
+    def list_line_items(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    def self.list_line_items(quote_phase, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quote_phases/%<quote_phase>s/line_items", { quote_phase: CGI.escape(quote_phase) }),
+        params: params,
+        opts: opts
+      )
+    end
+  end
+end

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

@@ -3,6 +3,10 @@
 
 module Stripe
   module Radar
+    # 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).
     class EarlyFraudWarning < APIResource
       extend Stripe::APIOperations::List
 

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value lists allow you to group values together which can then be referenced in rules.
+    #
+    # Related guide: [Default Stripe Lists](https://stripe.com/docs/radar/lists#managing-list-items).
     class ValueList < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

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

@@ -3,6 +3,9 @@
 
 module Stripe
   module Radar
+    # Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
+    #
+    # Related guide: [Managing List Items](https://stripe.com/docs/radar/lists#managing-list-items).
     class ValueListItem < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete

data/lib/stripe/resources/refund.rb

@@ -2,6 +2,11 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Refund` objects allow you to refund a charge that has previously been created
+  # but not yet refunded. Funds will be refunded to the credit or debit card that
+  # was originally charged.
+  #
+  # Related guide: [Refunds](https://stripe.com/docs/refunds).
   class Refund < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/reporting/report_run.rb

@@ -3,6 +3,14 @@
 
 module Stripe
   module Reporting
+    # The Report Run object represents an instance of a report type generated with
+    # specific run parameters. Once the object is created, Stripe begins processing the report.
+    # When the report has finished running, it will give you a reference to a file
+    # where you can retrieve your results. For an overview, see
+    # [API Access to Reports](https://stripe.com/docs/reporting/statements/api).
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).
     class ReportRun < APIResource
       extend Stripe::APIOperations::Create
       extend Stripe::APIOperations::List

data/lib/stripe/resources/reporting/report_type.rb

@@ -3,6 +3,14 @@
 
 module Stripe
   module Reporting
+    # The Report Type resource corresponds to a particular type of report, such as
+    # the "Activity summary" or "Itemized payouts" reports. These objects are
+    # identified by an ID belonging to a set of enumerated values. See
+    # [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)
+    # for those Report Type IDs, along with required and optional parameters.
+    #
+    # Note that certain report types can only be run based on your live-mode data (not test-mode
+    # data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).
     class ReportType < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/reversal.rb

@@ -2,6 +2,19 @@
 # frozen_string_literal: true
 
 module Stripe
+  # [Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a
+  # connected account, either entirely or partially, and can also specify whether
+  # to refund any related application fees. Transfer reversals add to the
+  # platform's balance and subtract from the destination account's balance.
+  #
+  # Reversing a transfer that was made for a [destination
+  # charge](https://stripe.com/docs/connect/destination-charges) is allowed only up to the amount of
+  # the charge. It is possible to reverse a
+  # [transfer_group](https://stripe.com/docs/connect/charges-transfers#transfer-options)
+  # transfer only if the destination account has enough balance to cover the
+  # reversal.
+  #
+  # Related guide: [Reversing Transfers](https://stripe.com/docs/connect/charges-transfers#reversing-transfers).
   class Reversal < APIResource
     extend Stripe::APIOperations::List
     include Stripe::APIOperations::Save

data/lib/stripe/resources/review.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Reviews can be used to supplement automated fraud detection with human expertise.
+  #
+  # Learn more about [Radar](https://stripe.com/radar) and reviewing payments
+  # [here](https://stripe.com/docs/radar/reviews).
   class Review < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/setup_attempt.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A SetupAttempt describes one attempted confirmation of a SetupIntent,
+  # whether that confirmation was successful or unsuccessful. You can use
+  # SetupAttempts to inspect details of a specific attempt at setting up a
+  # payment method using a SetupIntent.
   class SetupAttempt < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/setup_intent.rb

@@ -2,6 +2,28 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
+  # For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
+  # Later, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.
+  #
+  # Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
+  # Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
+  # The SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides
+  # you through the setup process.
+  #
+  # Successful SetupIntents result in payment credentials that are optimized for future payments.
+  # For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) may need to be run through
+  # [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection
+  # in order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).
+  # If the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,
+  # it will automatically attach the resulting payment method to that Customer.
+  # We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on
+  # PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
+  #
+  # By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
+  # even as regulations change over time.
+  #
+  # Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents).
   class SetupIntent < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/shipping_rate.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Shipping rates describe the price of shipping presented to your customers and can be
+  # applied to [Checkout Sessions](https://stripe.com/docs/payments/checkout/shipping)
+  # and [Orders](https://stripe.com/docs/orders/shipping) to collect shipping costs.
   class ShippingRate < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/sigma/scheduled_query_run.rb

@@ -3,6 +3,10 @@
 
 module Stripe
   module Sigma
+    # If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
+    # receive a `sigma.scheduled_query_run.created` webhook each time the query
+    # runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
+    # retrieve the query results.
     class ScheduledQueryRun < APIResource
       extend Stripe::APIOperations::List
 

data/lib/stripe/resources/sku.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Stores representations of [stock keeping units](http://en.wikipedia.org/wiki/Stock_keeping_unit).
+  # SKUs describe specific product variations, taking into account any combination of: attributes,
+  # currency, and cost. For example, a product may be a T-shirt, whereas a specific SKU represents
+  # the `size: large`, `color: red` version of that shirt.
+  #
+  # Can also be used to manage inventory.
   class SKU < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/source.rb

@@ -2,6 +2,12 @@
 # frozen_string_literal: true
 
 module Stripe
+  # `Source` objects allow you to accept a variety of payment methods. They
+  # represent a customer's payment instrument, and can be used with the Stripe API
+  # just like a `Card` object: once chargeable, they can be charged, or can be
+  # attached to customers.
+  #
+  # Related guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).
   class Source < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Save

data/lib/stripe/resources/source_transaction.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Some payment methods have no required amount that a customer must send.
+  # Customers can be instructed to send any amount, and it can be made up of
+  # multiple transactions. As such, sources can have multiple associated
+  # transactions.
   class SourceTransaction < StripeObject
     OBJECT_NAME = "source_transaction"
   end

data/lib/stripe/resources/subscription.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Subscriptions allow you to charge a customer on a recurring basis.
+  #
+  # Related guide: [Creating Subscriptions](https://stripe.com/docs/billing/subscriptions/creating).
   class Subscription < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

data/lib/stripe/resources/subscription_item.rb

@@ -2,6 +2,8 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Subscription items allow you to create customer subscriptions with more than
+  # one plan, making it easy to represent complex billing relationships.
   class SubscriptionItem < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete

data/lib/stripe/resources/subscription_schedule.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
+  #
+  # Related guide: [Subscription Schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
   class SubscriptionSchedule < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
@@ -9,6 +12,15 @@ module Stripe
 
     OBJECT_NAME = "subscription_schedule"
 
+    def amend(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def cancel(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -27,6 +39,15 @@ module Stripe
       )
     end
 
+    def self.amend(schedule, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/subscription_schedules/%<schedule>s/amend", { schedule: CGI.escape(schedule) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     def self.cancel(schedule, params = {}, opts = {})
       request_stripe_object(
         method: :post,

data/lib/stripe/resources/tax_code.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
+  # [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
   class TaxCode < APIResource
     extend Stripe::APIOperations::List
 

data/lib/stripe/resources/tax_id.rb

@@ -2,6 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
+  # You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).
+  # A customer's tax IDs are displayed on invoices and credit notes issued for the customer.
+  #
+  # Related guide: [Customer Tax Identification Numbers](https://stripe.com/docs/billing/taxes/tax-ids).
   class TaxId < APIResource
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List

data/lib/stripe/resources/tax_rate.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 module Stripe
+  # Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
+  #
+  # Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
   class TaxRate < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List

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

@@ -3,6 +3,7 @@
 
 module Stripe
   module Terminal
+    # A Configurations object represents how features should be configured for terminal readers.
     class Configuration < APIResource
       extend Stripe::APIOperations::Create
       include Stripe::APIOperations::Delete