stripe 13.3.0 → 13.4.0.pre.beta.1

data/rbi/stripe/resources/customer_balance_transaction.rbi

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Each customer has a [Balance](https://stripe.com/docs/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),
+  # 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)
+  class CustomerBalanceTransaction < APIResource
+    # The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`.
+    sig { returns(Integer) }
+    attr_reader :amount
+
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+
+    # The ID of the credit note (if any) related to the transaction.
+    sig { returns(T.nilable(T.any(String, Stripe::CreditNote))) }
+    attr_reader :credit_note
+
+    # 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).
+    sig { returns(String) }
+    attr_reader :currency
+
+    # The ID of the customer the transaction belongs to.
+    sig { returns(T.any(String, Stripe::Customer)) }
+    attr_reader :customer
+
+    # An arbitrary string attached to the object. Often useful for displaying to users.
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+
+    # The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice.
+    sig { returns(Integer) }
+    attr_reader :ending_balance
+
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+
+    # The ID of the invoice (if any) related to the transaction.
+    sig { returns(T.nilable(T.any(String, Stripe::Invoice))) }
+    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.
+    sig { returns(T::Boolean) }
+    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.
+    sig { returns(T.nilable(T::Hash[String, String])) }
+    attr_reader :metadata
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types.
+    sig { returns(String) }
+    attr_reader :type
+  end
+end

data/rbi/stripe/resources/customer_cash_balance_transaction.rbi

@@ -0,0 +1,178 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Customers with certain payments enabled have a cash balance, representing funds that were paid
+  # by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions
+  # represent when funds are moved into or out of this balance. This includes funding by the customer, allocation
+  # to payments, and refunds to the customer.
+  class CustomerCashBalanceTransaction < APIResource
+    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.
+      sig { returns(T.any(String, Stripe::BalanceTransaction)) }
+      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.
+      sig { returns(T.any(String, Stripe::CustomerCashBalanceTransaction)) }
+      attr_reader :linked_transaction
+    end
+    class AppliedToPayment < Stripe::StripeObject
+      # The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to.
+      sig { returns(T.any(String, Stripe::PaymentIntent)) }
+      attr_reader :payment_intent
+    end
+    class Funded < Stripe::StripeObject
+      class BankTransfer < Stripe::StripeObject
+        class EuBankTransfer < Stripe::StripeObject
+          # The BIC of the bank of the sender of the funding.
+          sig { returns(T.nilable(String)) }
+          attr_reader :bic
+
+          # The last 4 digits of the IBAN of the sender of the funding.
+          sig { returns(T.nilable(String)) }
+          attr_reader :iban_last4
+
+          # The full name of the sender, as supplied by the sending bank.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_name
+        end
+        class GbBankTransfer < Stripe::StripeObject
+          # The last 4 digits of the account number of the sender of the funding.
+          sig { returns(T.nilable(String)) }
+          attr_reader :account_number_last4
+
+          # The full name of the sender, as supplied by the sending bank.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_name
+
+          # The sort code of the bank of the sender of the funding
+          sig { returns(T.nilable(String)) }
+          attr_reader :sort_code
+        end
+        class JpBankTransfer < Stripe::StripeObject
+          # The name of the bank of the sender of the funding.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_bank
+
+          # The name of the bank branch of the sender of the funding.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_branch
+
+          # The full name of the sender, as supplied by the sending bank.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_name
+        end
+        class UsBankTransfer < Stripe::StripeObject
+          # The banking network used for this funding.
+          sig { returns(String) }
+          attr_reader :network
+
+          # The full name of the sender, as supplied by the sending bank.
+          sig { returns(T.nilable(String)) }
+          attr_reader :sender_name
+        end
+        # Attribute for field eu_bank_transfer
+        sig { returns(EuBankTransfer) }
+        attr_reader :eu_bank_transfer
+
+        # Attribute for field gb_bank_transfer
+        sig { returns(GbBankTransfer) }
+        attr_reader :gb_bank_transfer
+
+        # Attribute for field jp_bank_transfer
+        sig { returns(JpBankTransfer) }
+        attr_reader :jp_bank_transfer
+
+        # The user-supplied reference field on the bank transfer.
+        sig { returns(T.nilable(String)) }
+        attr_reader :reference
+
+        # The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
+        sig { returns(String) }
+        attr_reader :type
+
+        # Attribute for field us_bank_transfer
+        sig { returns(UsBankTransfer) }
+        attr_reader :us_bank_transfer
+      end
+      # Attribute for field bank_transfer
+      sig { returns(BankTransfer) }
+      attr_reader :bank_transfer
+    end
+    class RefundedFromPayment < Stripe::StripeObject
+      # The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance.
+      sig { returns(T.any(String, Stripe::Refund)) }
+      attr_reader :refund
+    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.
+      sig { returns(T.any(String, Stripe::BalanceTransaction)) }
+      attr_reader :balance_transaction
+    end
+    class UnappliedFromPayment < Stripe::StripeObject
+      # The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from.
+      sig { returns(T.any(String, Stripe::PaymentIntent)) }
+      attr_reader :payment_intent
+    end
+    # Attribute for field adjusted_for_overdraft
+    sig { returns(AdjustedForOverdraft) }
+    attr_reader :adjusted_for_overdraft
+
+    # Attribute for field applied_to_payment
+    sig { returns(AppliedToPayment) }
+    attr_reader :applied_to_payment
+
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+
+    # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+    sig { returns(String) }
+    attr_reader :currency
+
+    # The customer whose available cash balance changed as a result of this transaction.
+    sig { returns(T.any(String, Stripe::Customer)) }
+    attr_reader :customer
+
+    # 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).
+    sig { returns(Integer) }
+    attr_reader :ending_balance
+
+    # Attribute for field funded
+    sig { returns(Funded) }
+    attr_reader :funded
+
+    # Unique identifier for the object.
+    sig { returns(String) }
+    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.
+    sig { returns(T::Boolean) }
+    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.
+    sig { returns(Integer) }
+    attr_reader :net_amount
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # Attribute for field refunded_from_payment
+    sig { returns(RefundedFromPayment) }
+    attr_reader :refunded_from_payment
+
+    # Attribute for field transferred_to_balance
+    sig { returns(TransferredToBalance) }
+    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.
+    sig { returns(String) }
+    attr_reader :type
+
+    # Attribute for field unapplied_from_payment
+    sig { returns(UnappliedFromPayment) }
+    attr_reader :unapplied_from_payment
+  end
+end

data/rbi/stripe/resources/customer_session.rbi

@@ -0,0 +1,227 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A Customer Session allows you to grant Stripe's frontend SDKs (like Stripe.js) client-side access
+  # control over a Customer.
+  #
+  # Related guides: [Customer Session with the Payment Element](https://stripe.com/payments/accept-a-payment-deferred?platform=web&type=payment#save-payment-methods),
+  # [Customer Session with the Pricing Table](https://stripe.com/payments/checkout/pricing-table#customer-session),
+  # [Customer Session with the Buy Button](https://stripe.com/payment-links/buy-button#pass-an-existing-customer).
+  class CustomerSession < APIResource
+    class Components < Stripe::StripeObject
+      class BuyButton < Stripe::StripeObject
+        # Whether the buy button is enabled.
+        sig { returns(T::Boolean) }
+        attr_reader :enabled
+      end
+      class PaymentElement < Stripe::StripeObject
+        class Features < Stripe::StripeObject
+          # A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+          #
+          # If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+          sig { returns(T::Array[String]) }
+          attr_reader :payment_method_allow_redisplay_filters
+
+          # Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
+          sig { returns(String) }
+          attr_reader :payment_method_redisplay
+
+          # Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :payment_method_redisplay_limit
+
+          # Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
+          #
+          # Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+          sig { returns(String) }
+          attr_reader :payment_method_remove
+
+          # Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.
+          #
+          # If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+          sig { returns(String) }
+          attr_reader :payment_method_save
+
+          # When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.
+          #
+          # When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.
+          sig { returns(T.nilable(String)) }
+          attr_reader :payment_method_save_usage
+        end
+        # Whether the Payment Element is enabled.
+        sig { returns(T::Boolean) }
+        attr_reader :enabled
+
+        # This hash defines whether the Payment Element supports certain features.
+        sig { returns(T.nilable(Features)) }
+        attr_reader :features
+      end
+      class PricingTable < Stripe::StripeObject
+        # Whether the pricing table is enabled.
+        sig { returns(T::Boolean) }
+        attr_reader :enabled
+      end
+      # This hash contains whether the buy button is enabled.
+      sig { returns(BuyButton) }
+      attr_reader :buy_button
+
+      # This hash contains whether the Payment Element is enabled and the features it supports.
+      sig { returns(PaymentElement) }
+      attr_reader :payment_element
+
+      # This hash contains whether the pricing table is enabled.
+      sig { returns(PricingTable) }
+      attr_reader :pricing_table
+    end
+    # The client secret of this Customer Session. Used on the client to set up secure access to the given `customer`.
+    #
+    # The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret.
+    sig { returns(String) }
+    attr_reader :client_secret
+
+    # Configuration for the components supported by this Customer Session.
+    sig { returns(Components) }
+    attr_reader :components
+
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+
+    # The Customer the Customer Session was created for.
+    sig { returns(T.any(String, Stripe::Customer)) }
+    attr_reader :customer
+
+    # The timestamp at which this Customer Session will expire.
+    sig { returns(Integer) }
+    attr_reader :expires_at
+
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    class CreateParams < Stripe::RequestParams
+      class Components < Stripe::RequestParams
+        class BuyButton < Stripe::RequestParams
+          # Whether the buy button is enabled.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          sig { params(enabled: T::Boolean).void }
+          def initialize(enabled: nil); end
+        end
+        class PaymentElement < Stripe::RequestParams
+          class Features < Stripe::RequestParams
+            # A list of [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) values that controls which saved payment methods the Payment Element displays by filtering to only show payment methods with an `allow_redisplay` value that is present in this list.
+            #
+            # If not specified, defaults to ["always"]. In order to display all saved payment methods, specify ["always", "limited", "unspecified"].
+            sig { returns(T::Array[String]) }
+            attr_accessor :payment_method_allow_redisplay_filters
+
+            # Controls whether or not the Payment Element shows saved payment methods. This parameter defaults to `disabled`.
+            sig { returns(String) }
+            attr_accessor :payment_method_redisplay
+
+            # Determines the max number of saved payment methods for the Payment Element to display. This parameter defaults to `3`.
+            sig { returns(Integer) }
+            attr_accessor :payment_method_redisplay_limit
+
+            # Controls whether the Payment Element displays the option to remove a saved payment method. This parameter defaults to `disabled`.
+            #
+            # Allowing buyers to remove their saved payment methods impacts subscriptions that depend on that payment method. Removing the payment method detaches the [`customer` object](https://docs.stripe.com/api/payment_methods/object#payment_method_object-customer) from that [PaymentMethod](https://docs.stripe.com/api/payment_methods).
+            sig { returns(String) }
+            attr_accessor :payment_method_remove
+
+            # Controls whether the Payment Element displays a checkbox offering to save a new payment method. This parameter defaults to `disabled`.
+            #
+            # If a customer checks the box, the [`allow_redisplay`](https://docs.stripe.com/api/payment_methods/object#payment_method_object-allow_redisplay) value on the PaymentMethod is set to `'always'` at confirmation time. For PaymentIntents, the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value is also set to the value defined in `payment_method_save_usage`.
+            sig { returns(String) }
+            attr_accessor :payment_method_save
+
+            # When using PaymentIntents and the customer checks the save checkbox, this field determines the [`setup_future_usage`](https://docs.stripe.com/api/payment_intents/object#payment_intent_object-setup_future_usage) value used to confirm the PaymentIntent.
+            #
+            # When using SetupIntents, directly configure the [`usage`](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-usage) value on SetupIntent creation.
+            sig { returns(String) }
+            attr_accessor :payment_method_save_usage
+
+            sig {
+              params(payment_method_allow_redisplay_filters: T::Array[String], payment_method_redisplay: String, payment_method_redisplay_limit: Integer, payment_method_remove: String, payment_method_save: String, payment_method_save_usage: String).void
+             }
+            def initialize(
+              payment_method_allow_redisplay_filters: nil,
+              payment_method_redisplay: nil,
+              payment_method_redisplay_limit: nil,
+              payment_method_remove: nil,
+              payment_method_save: nil,
+              payment_method_save_usage: nil
+            ); end
+          end
+          # Whether the Payment Element is enabled.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # This hash defines whether the Payment Element supports certain features.
+          sig {
+            returns(::Stripe::CustomerSession::CreateParams::Components::PaymentElement::Features)
+           }
+          attr_accessor :features
+
+          sig {
+            params(enabled: T::Boolean, features: ::Stripe::CustomerSession::CreateParams::Components::PaymentElement::Features).void
+           }
+          def initialize(enabled: nil, features: nil); end
+        end
+        class PricingTable < Stripe::RequestParams
+          # Whether the pricing table is enabled.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          sig { params(enabled: T::Boolean).void }
+          def initialize(enabled: nil); end
+        end
+        # Configuration for buy button.
+        sig { returns(::Stripe::CustomerSession::CreateParams::Components::BuyButton) }
+        attr_accessor :buy_button
+
+        # Configuration for the Payment Element.
+        sig { returns(::Stripe::CustomerSession::CreateParams::Components::PaymentElement) }
+        attr_accessor :payment_element
+
+        # Configuration for the pricing table.
+        sig { returns(::Stripe::CustomerSession::CreateParams::Components::PricingTable) }
+        attr_accessor :pricing_table
+
+        sig {
+          params(buy_button: ::Stripe::CustomerSession::CreateParams::Components::BuyButton, payment_element: ::Stripe::CustomerSession::CreateParams::Components::PaymentElement, pricing_table: ::Stripe::CustomerSession::CreateParams::Components::PricingTable).void
+         }
+        def initialize(buy_button: nil, payment_element: nil, pricing_table: nil); end
+      end
+      # Configuration for each component. Exactly 1 component must be enabled.
+      sig { returns(::Stripe::CustomerSession::CreateParams::Components) }
+      attr_accessor :components
+
+      # The ID of an existing customer for which to create the Customer Session.
+      sig { returns(String) }
+      attr_accessor :customer
+
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+
+      sig {
+        params(components: ::Stripe::CustomerSession::CreateParams::Components, customer: String, expand: T::Array[String]).void
+       }
+      def initialize(components: nil, customer: nil, expand: nil); end
+    end
+    # Creates a Customer Session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.
+    sig {
+      params(params: T.any(::Stripe::CustomerSession::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::CustomerSession)
+     }
+    def self.create(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/discount.rbi

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+  # It contains information about when the discount began, when it will end, and what it is applied to.
+  #
+  # Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
+  class Discount < StripeObject
+    # The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.
+    sig { returns(T.nilable(String)) }
+    attr_reader :checkout_session
+
+    # 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).
+    sig { returns(Stripe::Coupon) }
+    attr_reader :coupon
+
+    # The ID of the customer associated with this discount.
+    sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
+    attr_reader :customer
+
+    # If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :end
+
+    # The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.
+    sig { returns(String) }
+    attr_reader :id
+
+    # The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.
+    sig { returns(T.nilable(String)) }
+    attr_reader :invoice
+
+    # The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.
+    sig { returns(T.nilable(String)) }
+    attr_reader :invoice_item
+
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+
+    # The promotion code applied to create this discount.
+    sig { returns(T.nilable(T.any(String, Stripe::PromotionCode))) }
+    attr_reader :promotion_code
+
+    # Date that the coupon was applied.
+    sig { returns(Integer) }
+    attr_reader :start
+
+    # The subscription that this coupon is applied to, if it is applied to a particular subscription.
+    sig { returns(T.nilable(String)) }
+    attr_reader :subscription
+
+    # The subscription item that this coupon is applied to, if it is applied to a particular subscription item.
+    sig { returns(T.nilable(String)) }
+    attr_reader :subscription_item
+
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+  end
+end